@itentialopensource/adapter-solarwinds_servicedesk
Version:
This adapter integrates with system described as: solarwindsServiceDeskApi.
26,626 lines • 956 kB
JSON
{
"openapi": "3.1.0",
"info": {
"title": "",
"version": "1.0.0"
},
"paths": {
"/incidents/{id}.json": {
"get": {
"tags": [
"Incident"
],
"operationId": "getIncidentById",
"description": "The parameters and request body are for method: getIncidentById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"due_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"solutions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"is_service_request": {
"type": "boolean"
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"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"
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Incident"
],
"operationId": "updateIncidentById",
"description": "The parameters and request body are for method: updateIncidentById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"due_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"solutions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"is_service_request": {
"type": "boolean"
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"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"
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Incident"
],
"operationId": "deleteIncidentById",
"description": "The parameters and request body are for method: deleteIncidentById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/incidents.json": {
"get": {
"tags": [
"Incident"
],
"operationId": "getIncidents",
"description": "The parameters and request body are for method: getIncidents. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"due_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"solutions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"is_service_request": {
"type": "boolean"
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"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"
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Incident"
],
"operationId": "createIncident",
"description": "The parameters and request body are for method: createIncident. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"due_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"solutions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"is_service_request": {
"type": "boolean"
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"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"
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/problems/{id}.json": {
"get": {
"tags": [
"Problem"
],
"operationId": "getProblemById",
"description": "The parameters and request body are for method: getProblemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"problem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"root_cause": {
"type": "string"
},
"symptoms": {
"type": "string"
},
"workaround": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Problem"
],
"operationId": "updateProblemById",
"description": "The parameters and request body are for method: updateProblemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"problem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"root_cause": {
"type": "string"
},
"symptoms": {
"type": "string"
},
"workaround": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Problem"
],
"operationId": "deleteProblemById",
"description": "The parameters and request body are for method: deleteProblemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/problems.json": {
"get": {
"tags": [
"Problem"
],
"operationId": "getProblems",
"description": "The parameters and request body are for method: getProblems. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"problem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"root_cause": {
"type": "string"
},
"symptoms": {
"type": "string"
},
"workaround": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
}
},
"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"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Problem"
],
"operationId": "createProblem",
"description": "The parameters and request body are for method: createProblem. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"problem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"root_cause": {
"type": "string"
},
"symptoms": {
"type": "string"
},
"workaround": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/changes/{id}.json": {
"get": {
"tags": [
"Change"
],
"operationId": "getChangeById",
"description": "The parameters and request body are for method: getChangeById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"change": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"change_plan": {
"type": "string"
},
"rollback_plan": {
"type": "string"
},
"test_plan": {
"type": "string"
},
"planned_start_at": {
"type": "string"
},
"planned_end_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"created_at": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Change"
],
"operationId": "updateChangeById",
"description": "The parameters and request body are for method: updateChangeById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"change": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"change_plan": {
"type": "string"
},
"rollback_plan": {
"type": "string"
},
"test_plan": {
"type": "string"
},
"planned_start_at": {
"type": "string"
},
"planned_end_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"created_at": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Change"
],
"operationId": "deleteChangeById",
"description": "The parameters and request body are for method: deleteChangeById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/changes.json": {
"get": {
"tags": [
"Change"
],
"operationId": "getChanges",
"description": "The parameters and request body are for method: getChanges. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"change": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"change_plan": {
"type": "string"
},
"rollback_plan": {
"type": "string"
},
"test_plan": {
"type": "string"
},
"planned_start_at": {
"type": "string"
},
"planned_end_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"created_at": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
}
},
"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"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Change"
],
"operationId": "createChange",
"description": "The parameters and request body are for method: createChange. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"change": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"change_plan": {
"type": "string"
},
"rollback_plan": {
"type": "string"
},
"test_plan": {
"type": "string"
},
"planned_start_at": {
"type": "string"
},
"planned_end_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"created_at": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/change_catalogs/{id}.json": {
"get": {
"tags": [
"ChangeCatalog"
],
"operationId": "getChangeCatalogById",
"description": "The parameters and request body are for method: getChangeCatalogById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"change_catalog": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"default_assignee_id": {
"type": "number"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"change_plan": {
"type": "string"
},
"rollback_plan": {
"type": "string"
},
"test_plan": {
"type": "string"
},
"origin": {
"type": "string"
},
"created_at": {
"type": "string"
},
"show_in_portal": {
"type": "boolean"
}
}
}
}
},
"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
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"ChangeCatalog"
],
"operationId": "updateChangeCatalogById",
"description": "The parameters and request body are for method: updateChangeCatalogById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"change_catalog": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"default_assignee_id": {
"type": "number"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"change_plan": {
"type": "string"
},
"rollback_plan": {
"type": "string"
},
"test_plan": {
"type": "string"
},
"origin": {
"type": "string"
},
"created_at": {
"type": "string"
},
"show_in_portal": {
"type": "boolean"
}
}
}
}
},
"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
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"ChangeCatalog"
],
"operationId": "deleteChangeCatalogById",
"description": "The parameters and request body are for method: deleteChangeCatalogById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/change_catalogs.json": {
"get": {
"tags": [
"ChangeCatalog"
],
"operationId": "getChangeCatalogs",
"description": "The parameters and request body are for method: getChangeCatalogs. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"change_catalog": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"default_assignee_id": {
"type": "number"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"change_plan": {
"type": "string"
},
"rollback_plan": {
"type": "string"
},
"test_plan": {
"type": "string"
},
"origin": {
"type": "string"
},
"created_at": {
"type": "string"
},
"show_in_portal": {
"type": "boolean"
}
}
}
}
}
},
"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
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"ChangeCatalog"
],
"operationId": "createChangeCatalog",
"description": "The parameters and request body are for method: createChangeCatalog. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"change_catalog": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"default_assignee_id": {
"type": "number"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"change_plan": {
"type": "string"
},
"rollback_plan": {
"type": "string"
},
"test_plan": {
"type": "string"
},
"origin": {
"type": "string"
},
"created_at": {
"type": "string"
},
"show_in_portal": {
"type": "boolean"
}
}
}
}
},
"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
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/releases/{id}.json": {
"get": {
"tags": [
"Release"
],
"operationId": "getReleaseById",
"description": "The parameters and request body are for method: getReleaseById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"release": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"plan": {
"type": "string"
},
"build": {
"type": "string"
},
"deploy": {
"type": "string"
},
"planned_start_at": {
"type": "string"
},
"planned_end_at": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"approvers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Release"
],
"operationId": "updateReleaseById",
"description": "The parameters and request body are for method: updateReleaseById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"release": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"plan": {
"type": "string"
},
"build": {
"type": "string"
},
"deploy": {
"type": "string"
},
"planned_start_at": {
"type": "string"
},
"planned_end_at": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"approvers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Release"
],
"operationId": "deleteReleaseById",
"description": "The parameters and request body are for method: deleteReleaseById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/releases.json": {
"get": {
"tags": [
"Release"
],
"operationId": "getRelease",
"description": "The parameters and request body are for method: getRelease. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"release": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"plan": {
"type": "string"
},
"build": {
"type": "string"
},
"deploy": {
"type": "string"
},
"planned_start_at": {
"type": "string"
},
"planned_end_at": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"approvers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
}
},
"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"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Release"
],
"operationId": "createRelease",
"description": "The parameters and request body are for method: createRelease. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"release": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"plan": {
"type": "string"
},
"build": {
"type": "string"
},
"deploy": {
"type": "string"
},
"planned_start_at": {
"type": "string"
},
"planned_end_at": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"approvers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/solutions/{id}.json": {
"get": {
"tags": [
"Solution"
],
"operationId": "getSolutionById",
"description": "The parameters and request body are for method: getSolutionById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"solution": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Solution"
],
"operationId": "updateSolutionById",
"description": "The parameters and request body are for method: updateSolutionById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"solution": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Solution"
],
"operationId": "deleteSolutionById",
"description": "The parameters and request body are for method: deleteSolutionById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/solutions.json": {
"get": {
"tags": [
"Solution"
],
"operationId": "getSolutions",
"description": "The parameters and request body are for method: getSolutions. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"solution": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
}
},
"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"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Solution"
],
"operationId": "createSolution",
"description": "The parameters and request body are for method: createSolution. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"solution": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/catalog_items/{id}.json": {
"get": {
"tags": [
"CatalogItem"
],
"operationId": "getCatalogItemById",
"description": "The parameters and request body are for method: getCatalogItemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"catalog_item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"expected_delivery_time": {
"type": "string"
},
"currency": {
"type": "string"
},
"price": {
"type": "string"
},
"show_price": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"CatalogItem"
],
"operationId": "updateCatalogItemById",
"description": "The parameters and request body are for method: updateCatalogItemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"catalog_item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"expected_delivery_time": {
"type": "string"
},
"currency": {
"type": "string"
},
"price": {
"type": "string"
},
"show_price": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"CatalogItem"
],
"operationId": "deleteCatalogItemById",
"description": "The parameters and request body are for method: deleteCatalogItemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/catalog_items.json": {
"get": {
"tags": [
"CatalogItem"
],
"operationId": "getCatalogItems",
"description": "The parameters and request body are for method: getCatalogItems. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"catalog_item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"expected_delivery_time": {
"type": "string"
},
"currency": {
"type": "string"
},
"price": {
"type": "string"
},
"show_price": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
}
},
"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"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"CatalogItem"
],
"operationId": "createCatalogItem",
"description": "The parameters and request body are for method: createCatalogItem. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"catalog_item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"expected_delivery_time": {
"type": "string"
},
"currency": {
"type": "string"
},
"price": {
"type": "string"
},
"show_price": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/catalog_items/{id}/service_requests.json": {
"post": {
"tags": [
"ServiceRequest"
],
"operationId": "createServiceRequest",
"description": "The parameters and request body are for method: createServiceRequest. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"subcategory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"default_tags": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"priority": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"due_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"solutions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"is_service_request": {
"type": "boolean"
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"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"
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/configuration_items/{id}.json": {
"get": {
"tags": [
"ConfigurationItem"
],
"operationId": "getConfigurationItemById",
"description": "The parameters and request body are for method: getConfigurationItemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"configuration_item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"asset_tag": {
"type": "string"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parent_id": {
"type": "number"
},
"custom": {
"type": "boolean"
},
"updated_at": {
"type": "string"
},
"icon_name": {
"type": "string"
}
}
},
"type_id": {
"type": "number"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"manager_id": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"user_id": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"purchase_orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"ConfigurationItem"
],
"operationId": "updateConfigurationItemById",
"description": "The parameters and request body are for method: updateConfigurationItemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"configuration_item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"asset_tag": {
"type": "string"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parent_id": {
"type": "number"
},
"custom": {
"type": "boolean"
},
"updated_at": {
"type": "string"
},
"icon_name": {
"type": "string"
}
}
},
"type_id": {
"type": "number"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"manager_id": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"user_id": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"purchase_orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"ConfigurationItem"
],
"operationId": "deleteConfigurationItemById",
"description": "The parameters and request body are for method: deleteConfigurationItemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/configuration_items.json": {
"get": {
"tags": [
"ConfigurationItem"
],
"operationId": "getConfigurationItems",
"description": "The parameters and request body are for method: getConfigurationItems. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"configuration_item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"asset_tag": {
"type": "string"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parent_id": {
"type": "number"
},
"custom": {
"type": "boolean"
},
"updated_at": {
"type": "string"
},
"icon_name": {
"type": "string"
}
}
},
"type_id": {
"type": "number"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"manager_id": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"user_id": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"purchase_orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
}
},
"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"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"ConfigurationItem"
],
"operationId": "createConfigurationItem",
"description": "The parameters and request body are for method: createConfigurationItem. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"configuration_item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"asset_tag": {
"type": "string"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parent_id": {
"type": "number"
},
"custom": {
"type": "boolean"
},
"updated_at": {
"type": "string"
},
"icon_name": {
"type": "string"
}
}
},
"type_id": {
"type": "number"
},
"state": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"manager_id": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"user_id": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"origin": {
"type": "string"
},
"incidents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"purchase_orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
},
"configuration_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/configuration_items/{id}/append_multiple_dependent_assets.json": {
"put": {
"tags": [
"ConfigurationItem"
],
"operationId": "appendDependentAssets",
"description": "The parameters and request body are for method: appendDependentAssets. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/asset_links/delete_asset_link_by_id.json": {
"put": {
"tags": [
"ConfigurationItem"
],
"operationId": "deleteAssetLink",
"description": "The parameters and request body are for method: deleteAssetLink. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/users/{id}.json": {
"get": {
"tags": [
"User"
],
"operationId": "getUserById",
"description": "The parameters and request body are for method: getUserById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"email": {
"type": "string"
},
"created_at": {
"type": "string"
},
"phone": {
"type": "string"
},
"mobile_phone": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "boolean"
},
"show_my_tasks": {
"type": "boolean"
}
}
},
"group_ids": {
"type": "array",
"items": {
"type": "number"
}
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"reports_to": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"User"
],
"operationId": "updateUserById",
"description": "The parameters and request body are for method: updateUserById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"email": {
"type": "string"
},
"created_at": {
"type": "string"
},
"phone": {
"type": "string"
},
"mobile_phone": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "boolean"
},
"show_my_tasks": {
"type": "boolean"
}
}
},
"group_ids": {
"type": "array",
"items": {
"type": "number"
}
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"reports_to": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"User"
],
"operationId": "deleteUserById",
"description": "The parameters and request body are for method: deleteUserById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted user"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/users.json": {
"get": {
"tags": [
"User"
],
"operationId": "getUsers",
"description": "The parameters and request body are for method: getUsers. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"email": {
"type": "string"
},
"created_at": {
"type": "string"
},
"phone": {
"type": "string"
},
"mobile_phone": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "boolean"
},
"show_my_tasks": {
"type": "boolean"
}
}
},
"group_ids": {
"type": "array",
"items": {
"type": "number"
}
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"reports_to": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
}
},
"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"
}
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"User"
],
"operationId": "createUser",
"description": "The parameters and request body are for method: createUser. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"email": {
"type": "string"
},
"created_at": {
"type": "string"
},
"phone": {
"type": "string"
},
"mobile_phone": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "boolean"
},
"show_my_tasks": {
"type": "boolean"
}
}
},
"group_ids": {
"type": "array",
"items": {
"type": "number"
}
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"reports_to": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"is_user": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"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"
}
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/sites/{id}.json": {
"get": {
"tags": [
"Site"
],
"operationId": "getSiteById",
"description": "The parameters and request body are for method: getSiteById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
},
"language": {
"type": "string"
},
"business_record": {
"type": "string"
}
}
}
}
},
"example": {
"site": {
"id": null,
"name": "Austin TX, USA",
"location": "AUS",
"description": "Description Austin TX, USA",
"time_zone": "Texas",
"language": "en",
"business_record": "1"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Site"
],
"operationId": "updateSiteById",
"description": "The parameters and request body are for method: updateSiteById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
},
"language": {
"type": "string"
},
"business_record": {
"type": "string"
}
}
}
}
},
"example": {
"site": {
"id": null,
"name": "Austin TX, USA",
"location": "AUS",
"description": "Description Austin TX, USA",
"time_zone": "Texas",
"language": "en",
"business_record": "1"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Site"
],
"operationId": "deleteSiteById",
"description": "The parameters and request body are for method: deleteSiteById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted site"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/sites.json": {
"get": {
"tags": [
"Site"
],
"operationId": "getSites",
"description": "The parameters and request body are for method: getSites. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
},
"language": {
"type": "string"
},
"business_record": {
"type": "string"
}
}
}
}
}
},
"example": [
{
"site": {
"id": null,
"name": "Austin TX, USA",
"location": "AUS",
"description": "Description Austin TX, USA",
"time_zone": "Texas",
"language": "en",
"business_record": "1"
}
},
{
"site": {
"id": null,
"name": "Austin TX, USA",
"location": "AUS",
"description": "Description Austin TX, USA",
"time_zone": "Texas",
"language": "en",
"business_record": "1"
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Site"
],
"operationId": "createSite",
"description": "The parameters and request body are for method: createSite. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
},
"language": {
"type": "string"
},
"business_record": {
"type": "string"
}
}
}
}
},
"example": {
"site": {
"id": null,
"name": "Austin TX, USA",
"location": "AUS",
"description": "Description Austin TX, USA",
"time_zone": "Texas",
"language": "en",
"business_record": "1"
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/departments/{id}.json": {
"get": {
"tags": [
"Department"
],
"operationId": "getDepartmentById",
"description": "The parameters and request body are for method: getDepartmentById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
},
"example": {
"department": {
"id": null,
"name": "Support",
"description": "Support Department"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Department"
],
"operationId": "updateDepartmentById",
"description": "The parameters and request body are for method: updateDepartmentById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
},
"example": {
"department": {
"id": null,
"name": "Support",
"description": "Support Department"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Department"
],
"operationId": "deleteDepartmentById",
"description": "The parameters and request body are for method: deleteDepartmentById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted department"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/departments.json": {
"get": {
"tags": [
"Department"
],
"operationId": "getDepartments",
"description": "The parameters and request body are for method: getDepartments. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": [
{
"department": {
"id": null,
"name": "Support",
"description": "Support Department"
}
},
{
"department": {
"id": null,
"name": "Support",
"description": "Support Department"
}
},
{
"department": {
"id": null,
"name": "Support",
"description": "Support Department"
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Department"
],
"operationId": "createDepartment",
"description": "The parameters and request body are for method: createDepartment. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
},
"example": {
"department": {
"id": null,
"name": "Support",
"description": "Support Department"
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/roles/{id}.json": {
"get": {
"tags": [
"Role"
],
"operationId": "getRoleById",
"description": "The parameters and request body are for method: getRoleById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"role": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "boolean"
},
"show_my_tasks": {
"type": "boolean"
}
}
}
}
},
"example": {
"role": {
"id": null,
"name": "Support Agent",
"description": "Support Agent role",
"portal": true,
"show_my_tasks": true
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Role"
],
"operationId": "updateRoleById",
"description": "The parameters and request body are for method: updateRoleById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"role": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "boolean"
},
"show_my_tasks": {
"type": "boolean"
}
}
}
}
},
"example": {
"role": {
"id": null,
"name": "Support Agent",
"description": "Support Agent role",
"portal": true,
"show_my_tasks": true
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Role"
],
"operationId": "deleteRoleById",
"description": "The parameters and request body are for method: deleteRoleById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted role"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/roles.json": {
"get": {
"tags": [
"Role"
],
"operationId": "getRoles",
"description": "The parameters and request body are for method: getRoles. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "boolean"
},
"show_my_tasks": {
"type": "boolean"
}
}
}
}
}
},
"example": [
{
"role": {
"id": null,
"name": "Support Agent",
"description": "Support Agent role",
"portal": true,
"show_my_tasks": false
}
},
{
"role": {
"id": null,
"name": "Support Agent",
"description": "Support Agent role",
"portal": true,
"show_my_tasks": false
}
},
{
"role": {
"id": null,
"name": "Support Agent",
"description": "Support Agent role",
"portal": true,
"show_my_tasks": true
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Role"
],
"operationId": "createRole",
"description": "The parameters and request body are for method: createRole. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"role": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "boolean"
},
"show_my_tasks": {
"type": "boolean"
}
}
}
}
},
"example": {
"role": {
"id": null,
"name": "Support Agent",
"description": "Support Agent role",
"portal": true,
"show_my_tasks": false
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/groups/{id}.json": {
"get": {
"tags": [
"Group"
],
"operationId": "getGroupById",
"description": "The parameters and request body are for method: getGroupById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_user": {
"type": "boolean"
},
"reports_to": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"send_notifications": {
"type": "boolean"
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"user": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"group": {
"id": null,
"name": "Group Name",
"description": "Group Description",
"is_user": true,
"reports_to": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
},
"send_notifications": true,
"memberships": [
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Group"
],
"operationId": "updateGroupById",
"description": "The parameters and request body are for method: updateGroupById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_user": {
"type": "boolean"
},
"reports_to": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"send_notifications": {
"type": "boolean"
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"user": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"group": {
"id": null,
"name": "Group Name",
"description": "Group Description",
"is_user": true,
"reports_to": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
},
"send_notifications": true,
"memberships": [
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Group"
],
"operationId": "deleteGroupById",
"description": "The parameters and request body are for method: deleteGroupById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted group"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/groups.json": {
"get": {
"tags": [
"Group"
],
"operationId": "getGroups",
"description": "The parameters and request body are for method: getGroups. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_user": {
"type": "boolean"
},
"reports_to": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"send_notifications": {
"type": "boolean"
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"user": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": [
{
"group": {
"id": null,
"name": "Group Name",
"description": "Group Description",
"is_user": false,
"reports_to": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
},
"send_notifications": true,
"memberships": [
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
}
]
}
},
{
"group": {
"id": null,
"name": "Group Name",
"description": "Group Description",
"is_user": true,
"reports_to": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
},
"send_notifications": true,
"memberships": [
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
}
]
}
},
{
"group": {
"id": null,
"name": "Group Name",
"description": "Group Description",
"is_user": true,
"reports_to": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
},
"send_notifications": true,
"memberships": [
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
},
{
"id": null,
"user": "John Doe"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Group"
],
"operationId": "createGroup",
"description": "The parameters and request body are for method: createGroup. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_user": {
"type": "boolean"
},
"reports_to": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"send_notifications": {
"type": "boolean"
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"user": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"group": {
"id": null,
"name": "Group Name",
"description": "Group Description",
"is_user": true,
"reports_to": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
},
"send_notifications": true,
"memberships": [
{
"id": null,
"user": "John Doe"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/categories/{id}.json": {
"get": {
"tags": [
"Category"
],
"operationId": "getCategoryById",
"description": "The parameters and request body are for method: getCategoryById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"category": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"parent_id": {
"type": "object"
},
"default_tags": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
}
}
},
"example": {
"category": {
"id": null,
"name": "Equipment",
"parent_id": null,
"default_tags": "equipment",
"default_assignee_id": null
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Category"
],
"operationId": "updateCategoryById",
"description": "The parameters and request body are for method: updateCategoryById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"category": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"parent_id": {
"type": "object"
},
"default_tags": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
}
}
},
"example": {
"category": {
"id": null,
"name": "Equipment",
"parent_id": null,
"default_tags": "equipment",
"default_assignee_id": null
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Category"
],
"operationId": "deleteCategoryById",
"description": "The parameters and request body are for method: deleteCategoryById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted category"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/categories.json": {
"get": {
"tags": [
"Category"
],
"operationId": "getCategories",
"description": "The parameters and request body are for method: getCategories. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"parent_id": {
"type": "object"
},
"default_tags": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
}
}
}
},
"example": [
{
"category": {
"id": null,
"name": "Equipment",
"parent_id": null,
"default_tags": "equipment",
"default_assignee_id": null
}
},
{
"category": {
"id": null,
"name": "Equipment",
"parent_id": null,
"default_tags": "equipment",
"default_assignee_id": null
}
},
{
"category": {
"id": null,
"name": "Equipment",
"parent_id": null,
"default_tags": "equipment",
"default_assignee_id": null
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Category"
],
"operationId": "createCategory",
"description": "The parameters and request body are for method: createCategory. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"category": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"parent_id": {
"type": "object"
},
"default_tags": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
}
}
},
"example": {
"category": {
"id": null,
"name": "Equipment",
"parent_id": null,
"default_tags": "equipment",
"default_assignee_id": null
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/hardwares/{id}.json": {
"get": {
"tags": [
"Hardware"
],
"operationId": "getHardwareById",
"description": "The parameters and request body are for method: getHardwareById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hardware": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"ip": {
"type": "string"
},
"external_ip": {
"type": "string"
},
"status": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"owner": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"notes": {
"type": "string"
},
"barcode_encoding_format": {
"type": "string"
},
"cpu": {
"type": "string"
},
"processor_speed": {
"type": "string"
},
"memory": {
"type": "number"
},
"swap": {
"type": "string"
},
"operating_system": {
"type": "string"
},
"domain": {
"type": "string"
},
"active_directory": {
"type": "string"
},
"address": {
"type": "string"
},
"longitude": {
"type": "string"
},
"latitude": {
"type": "string"
},
"product_number": {
"type": "string"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"bioses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"manufacturer": {
"type": "string"
},
"ssn": {
"type": "string"
},
"model": {
"type": "string"
},
"version": {
"type": "string"
},
"bios_date": {
"type": "string"
},
"reported_at": {
"type": "string"
}
}
}
},
"tag": {
"type": "string"
},
"asset_tag": {
"type": "string"
}
}
}
}
},
"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"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Hardware"
],
"operationId": "updateHardwareById",
"description": "The parameters and request body are for method: updateHardwareById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hardware": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"ip": {
"type": "string"
},
"external_ip": {
"type": "string"
},
"status": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"owner": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"notes": {
"type": "string"
},
"barcode_encoding_format": {
"type": "string"
},
"cpu": {
"type": "string"
},
"processor_speed": {
"type": "string"
},
"memory": {
"type": "number"
},
"swap": {
"type": "string"
},
"operating_system": {
"type": "string"
},
"domain": {
"type": "string"
},
"active_directory": {
"type": "string"
},
"address": {
"type": "string"
},
"longitude": {
"type": "string"
},
"latitude": {
"type": "string"
},
"product_number": {
"type": "string"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"bioses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"manufacturer": {
"type": "string"
},
"ssn": {
"type": "string"
},
"model": {
"type": "string"
},
"version": {
"type": "string"
},
"bios_date": {
"type": "string"
},
"reported_at": {
"type": "string"
}
}
}
},
"tag": {
"type": "string"
},
"asset_tag": {
"type": "string"
}
}
}
}
},
"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"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Hardware"
],
"operationId": "deleteHardwareById",
"description": "The parameters and request body are for method: deleteHardwareById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/hardwares.json": {
"get": {
"tags": [
"Hardware"
],
"operationId": "getHardwares",
"description": "The parameters and request body are for method: getHardwares. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hardware": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"ip": {
"type": "string"
},
"external_ip": {
"type": "string"
},
"status": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"owner": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"notes": {
"type": "string"
},
"barcode_encoding_format": {
"type": "string"
},
"cpu": {
"type": "string"
},
"processor_speed": {
"type": "string"
},
"memory": {
"type": "number"
},
"swap": {
"type": "string"
},
"operating_system": {
"type": "string"
},
"domain": {
"type": "string"
},
"active_directory": {
"type": "string"
},
"address": {
"type": "string"
},
"longitude": {
"type": "string"
},
"latitude": {
"type": "string"
},
"product_number": {
"type": "string"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"bioses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"manufacturer": {
"type": "string"
},
"ssn": {
"type": "string"
},
"model": {
"type": "string"
},
"version": {
"type": "string"
},
"bios_date": {
"type": "string"
},
"reported_at": {
"type": "string"
}
}
}
},
"tag": {
"type": "string"
},
"asset_tag": {
"type": "string"
}
}
}
}
}
},
"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"
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Hardware"
],
"operationId": "createHardware",
"description": "The parameters and request body are for method: createHardware. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hardware": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "string"
}
}
},
"ip": {
"type": "string"
},
"external_ip": {
"type": "string"
},
"status": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"owner": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"notes": {
"type": "string"
},
"barcode_encoding_format": {
"type": "string"
},
"cpu": {
"type": "string"
},
"processor_speed": {
"type": "string"
},
"memory": {
"type": "number"
},
"swap": {
"type": "string"
},
"operating_system": {
"type": "string"
},
"domain": {
"type": "string"
},
"active_directory": {
"type": "string"
},
"address": {
"type": "string"
},
"longitude": {
"type": "string"
},
"latitude": {
"type": "string"
},
"product_number": {
"type": "string"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_field_id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"options": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"bioses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"manufacturer": {
"type": "string"
},
"ssn": {
"type": "string"
},
"model": {
"type": "string"
},
"version": {
"type": "string"
},
"bios_date": {
"type": "string"
},
"reported_at": {
"type": "string"
}
}
}
},
"tag": {
"type": "string"
},
"asset_tag": {
"type": "string"
}
}
}
}
},
"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"
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/hardwares/{id}/warranties.json": {
"get": {
"tags": [
"Hardware"
],
"operationId": "getWarranties",
"description": "The parameters and request body are for method: getWarranties. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"warranty": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"service": {
"type": "string"
},
"provider": {
"type": "string"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"status": {
"type": "string"
},
"manual": {
"type": "boolean"
}
}
}
}
}
},
"example": [
{
"warranty": {
"id": null,
"service": "Warranty service description",
"provider": "SolarWinds",
"start_date": "2020-01-01T00:00:00.000+01:00",
"end_date": "2030-01-01T00:00:00.000+01:00",
"status": "Active",
"manual": true
}
},
{
"warranty": {
"id": null,
"service": "Warranty service description",
"provider": "SolarWinds",
"start_date": "2020-01-01T00:00:00.000+01:00",
"end_date": "2030-01-01T00:00:00.000+01:00",
"status": "Active",
"manual": true
}
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Hardware"
],
"operationId": "createWarranty",
"description": "The parameters and request body are for method: createWarranty. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"warranty": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"service": {
"type": "string"
},
"provider": {
"type": "string"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"status": {
"type": "string"
},
"manual": {
"type": "boolean"
}
}
}
}
},
"example": {
"warranty": {
"id": null,
"service": "Warranty service description",
"provider": "SolarWinds",
"start_date": "2020-01-01T00:00:00.000+01:00",
"end_date": "2030-01-01T00:00:00.000+01:00",
"status": "Active",
"manual": true
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/hardwares/{hardwareId}/warranties/{warrantyId}.json": {
"put": {
"tags": [
"Hardware"
],
"operationId": "updateWarrantyById",
"description": "The parameters and request body are for method: updateWarrantyById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"warranty": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"service": {
"type": "string"
},
"provider": {
"type": "string"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"status": {
"type": "string"
},
"manual": {
"type": "boolean"
}
}
}
}
},
"example": {
"warranty": {
"id": null,
"service": "Warranty service description",
"provider": "SolarWinds",
"start_date": "2020-01-01T00:00:00.000+01:00",
"end_date": "2030-01-01T00:00:00.000+01:00",
"status": "Active",
"manual": false
}
}
}
}
}
},
"parameters": [
{
"name": "hardwareId",
"in": "path",
"required": true,
"schema": {
"title": "hardwareId",
"type": "string"
}
},
{
"name": "warrantyId",
"in": "path",
"required": true,
"schema": {
"title": "warrantyId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Hardware"
],
"operationId": "deleteWarrantyById",
"description": "The parameters and request body are for method: deleteWarrantyById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted warranty"
}
}
}
}
}
},
"parameters": [
{
"name": "hardwareId",
"in": "path",
"required": true,
"schema": {
"title": "hardwareId",
"type": "string"
}
},
{
"name": "warrantyId",
"in": "path",
"required": true,
"schema": {
"title": "warrantyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/mobiles/{id}.json": {
"get": {
"tags": [
"MobileDevice"
],
"operationId": "getMobileById",
"description": "The parameters and request body are for method: getMobileById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"status": {
"type": "string"
},
"device_type": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"company_issued": {
"type": "boolean"
},
"serial_number": {
"type": "object"
},
"imei": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"mobile": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"device_type": "Mobile Device",
"manufacturer": "Apple",
"model": "1",
"company_issued": true,
"serial_number": null,
"imei": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": false,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"technical_contact": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"MobileDevice"
],
"operationId": "updateMobileById",
"description": "The parameters and request body are for method: updateMobileById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"status": {
"type": "string"
},
"device_type": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"company_issued": {
"type": "boolean"
},
"serial_number": {
"type": "object"
},
"imei": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"mobile": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"device_type": "Mobile Device",
"manufacturer": "Apple",
"model": "1",
"company_issued": true,
"serial_number": null,
"imei": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": false,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"technical_contact": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"MobileDevice"
],
"operationId": "deleteMobileById",
"description": "The parameters and request body are for method: deleteMobileById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/mobiles.json": {
"get": {
"tags": [
"MobileDevice"
],
"operationId": "getMobiles",
"description": "The parameters and request body are for method: getMobiles. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mobile": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"status": {
"type": "string"
},
"device_type": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"company_issued": {
"type": "boolean"
},
"serial_number": {
"type": "object"
},
"imei": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": [
{
"mobile": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"device_type": "Mobile Device",
"manufacturer": "Apple",
"model": "1",
"company_issued": true,
"serial_number": null,
"imei": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": true,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"technical_contact": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
},
{
"mobile": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"device_type": "Mobile Device",
"manufacturer": "Apple",
"model": "1",
"company_issued": true,
"serial_number": null,
"imei": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": false,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"technical_contact": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"MobileDevice"
],
"operationId": "createMobile",
"description": "The parameters and request body are for method: createMobile. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"status": {
"type": "string"
},
"device_type": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"company_issued": {
"type": "boolean"
},
"serial_number": {
"type": "object"
},
"imei": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"mobile": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"device_type": "Mobile Device",
"manufacturer": "Apple",
"model": "1",
"company_issued": true,
"serial_number": null,
"imei": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": true,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"technical_contact": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/other_assets/{id}.json": {
"get": {
"tags": [
"OtherAsset"
],
"operationId": "getAssetById",
"description": "The parameters and request body are for method: getAssetById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"other_asset": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"status": {
"type": "string"
},
"asset_type": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"parent_id": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"asset_id": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"ip": {
"type": "string"
},
"serial_number": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"owner": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"other_asset": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"asset_type": {
"id": null,
"account_id": null,
"parent_id": null,
"name": "Asset Type"
},
"asset_id": "1",
"manufacturer": "Apple",
"model": "1",
"ip": "0.0.0.0",
"serial_number": null,
"user": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"owner": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"OtherAsset"
],
"operationId": "updateAssetById",
"description": "The parameters and request body are for method: updateAssetById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"other_asset": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"status": {
"type": "string"
},
"asset_type": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"parent_id": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"asset_id": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"ip": {
"type": "string"
},
"serial_number": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"owner": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"other_asset": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"asset_type": {
"id": null,
"account_id": null,
"parent_id": null,
"name": "Asset Type"
},
"asset_id": "1",
"manufacturer": "Apple",
"model": "1",
"ip": "0.0.0.0",
"serial_number": null,
"user": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"owner": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"OtherAsset"
],
"operationId": "deleteAssetById",
"description": "The parameters and request body are for method: deleteAssetById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/other_assets.json": {
"get": {
"tags": [
"OtherAsset"
],
"operationId": "getAssets",
"description": "The parameters and request body are for method: getAssets. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"other_asset": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"status": {
"type": "string"
},
"asset_type": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"parent_id": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"asset_id": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"ip": {
"type": "string"
},
"serial_number": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"owner": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": [
{
"other_asset": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"asset_type": {
"id": null,
"account_id": null,
"parent_id": null,
"name": "Asset Type"
},
"asset_id": "1",
"manufacturer": "Apple",
"model": "1",
"ip": "0.0.0.0",
"serial_number": null,
"user": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"owner": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
},
{
"other_asset": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"asset_type": {
"id": null,
"account_id": null,
"parent_id": null,
"name": "Asset Type"
},
"asset_id": "1",
"manufacturer": "Apple",
"model": "1",
"ip": "0.0.0.0",
"serial_number": null,
"user": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"owner": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"OtherAsset"
],
"operationId": "createAsset",
"description": "The parameters and request body are for method: createAsset. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"other_asset": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"status": {
"type": "string"
},
"asset_type": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"parent_id": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"asset_id": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"ip": {
"type": "string"
},
"serial_number": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"owner": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"other_asset": {
"id": null,
"name": "Apple 1",
"description": "description",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"status": "Operational",
"asset_type": {
"id": null,
"account_id": null,
"parent_id": null,
"name": "Asset Type"
},
"asset_id": "1",
"manufacturer": "Apple",
"model": "1",
"ip": "0.0.0.0",
"serial_number": null,
"user": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"owner": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/softwares/{id}.json": {
"get": {
"tags": [
"Software"
],
"operationId": "getSoftwareById",
"description": "The parameters and request body are for method: getSoftwareById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"software": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"version": {
"type": "string"
},
"category": {
"type": "string"
},
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"country": {
"type": "string"
},
"city": {
"type": "string"
},
"zip": {
"type": "string"
},
"tech_support": {
"type": "string"
},
"business_phone": {
"type": "string"
},
"url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"installs": {
"type": "number"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
}
},
"example": {
"software": {
"id": null,
"name": "Google Chrome",
"tag": "software tag",
"manufacturer": "Google LLC",
"version": "0.0.0",
"category": "Google softwares",
"vendor": {
"id": null,
"name": "Google",
"address": "address description",
"country": "US",
"city": "Texas",
"zip": "1",
"tech_support": "+000000000",
"business_phone": "+000000000",
"url": "www.google.com",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00"
},
"installs": 1,
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/softwares.json": {
"get": {
"tags": [
"Software"
],
"operationId": "getSoftwares",
"description": "The parameters and request body are for method: getSoftwares. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"software": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"version": {
"type": "string"
},
"category": {
"type": "string"
},
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"country": {
"type": "string"
},
"city": {
"type": "string"
},
"zip": {
"type": "string"
},
"tech_support": {
"type": "string"
},
"business_phone": {
"type": "string"
},
"url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"installs": {
"type": "number"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
}
}
},
"example": [
{
"software": {
"id": null,
"name": "Google Chrome",
"tag": "software tag",
"manufacturer": "Google LLC",
"version": "0.0.0",
"category": "Google softwares",
"vendor": {
"id": null,
"name": "Google",
"address": "address description",
"country": "US",
"city": "Texas",
"zip": "1",
"tech_support": "+000000000",
"business_phone": "+000000000",
"url": "www.google.com",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00"
},
"installs": 1,
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00"
}
},
{
"software": {
"id": null,
"name": "Google Chrome",
"tag": "software tag",
"manufacturer": "Google LLC",
"version": "0.0.0",
"category": "Google softwares",
"vendor": {
"id": null,
"name": "Google",
"address": "address description",
"country": "US",
"city": "Texas",
"zip": "1",
"tech_support": "+000000000",
"business_phone": "+000000000",
"url": "www.google.com",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00"
},
"installs": 1,
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00"
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/printers/{id}.json": {
"get": {
"tags": [
"Printer"
],
"operationId": "getPrinterById",
"description": "The parameters and request body are for method: getPrinterById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"printer": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"driver": {
"type": "string"
},
"port": {
"type": "string"
},
"shared": {
"type": "boolean"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": {
"printer": {
"id": null,
"name": "HP Color Printer",
"driver": "Driver description",
"port": "Port description",
"shared": true,
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"technical_contact": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Printer"
],
"operationId": "updatePrinterById",
"description": "The parameters and request body are for method: updatePrinterById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"printer": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"driver": {
"type": "string"
},
"port": {
"type": "string"
},
"shared": {
"type": "boolean"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": {
"printer": {
"id": null,
"name": "HP Color Printer",
"driver": "Driver description",
"port": "Port description",
"shared": true,
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"technical_contact": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/printers.json": {
"get": {
"tags": [
"Printer"
],
"operationId": "getPrinters",
"description": "The parameters and request body are for method: getPrinters. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"printer": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"driver": {
"type": "string"
},
"port": {
"type": "string"
},
"shared": {
"type": "boolean"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"technical_contact": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"example": [
{
"printer": {
"id": null,
"name": "HP Color Printer",
"driver": "Driver description",
"port": "Port description",
"shared": true,
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"technical_contact": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
}
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/contracts/{id}.json": {
"get": {
"tags": [
"Contract"
],
"operationId": "getContractById",
"description": "The parameters and request body are for method: getContractById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contract": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"manufacturer_name": {
"type": "string"
},
"note": {
"type": "string"
},
"status": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"quantity": {
"type": "string"
},
"notes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"contract": {
"id": null,
"name": "Contract Name",
"type": "Software License",
"manufacturer_name": "Apple",
"note": "Contract Note",
"status": "Active",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"start_date": "2020-01-01T00:00:00-00:00",
"end_date": "2030-01-01T00:00:00-00:00",
"tags": [
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
}
],
"items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Contract"
],
"operationId": "updateContractById",
"description": "The parameters and request body are for method: updateContractById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contract": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"manufacturer_name": {
"type": "string"
},
"note": {
"type": "string"
},
"status": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"quantity": {
"type": "string"
},
"notes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"contract": {
"id": null,
"name": "Contract Name",
"type": "Software License",
"manufacturer_name": "Apple",
"note": "Contract Note",
"status": "Active",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"start_date": "2020-01-01T00:00:00-00:00",
"end_date": "2030-01-01T00:00:00-00:00",
"tags": [
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
}
],
"items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Contract"
],
"operationId": "deleteContractById",
"description": "The parameters and request body are for method: deleteContractById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/contracts.json": {
"get": {
"tags": [
"Contract"
],
"operationId": "getContracts",
"description": "The parameters and request body are for method: getContracts. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"contract": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"manufacturer_name": {
"type": "string"
},
"note": {
"type": "string"
},
"status": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"quantity": {
"type": "string"
},
"notes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": [
{
"contract": {
"id": null,
"name": "Contract Name",
"type": "Software License",
"manufacturer_name": "Apple",
"note": "Contract Note",
"status": "Active",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"start_date": "2020-01-01T00:00:00-00:00",
"end_date": "2030-01-01T00:00:00-00:00",
"tags": [
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
}
],
"items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Contract"
],
"operationId": "createContract",
"description": "The parameters and request body are for method: createContract. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contract": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"manufacturer_name": {
"type": "string"
},
"note": {
"type": "string"
},
"status": {
"type": "string"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"taggings_count": {
"type": "number"
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"quantity": {
"type": "string"
},
"notes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"contract": {
"id": null,
"name": "Contract Name",
"type": "Software License",
"manufacturer_name": "Apple",
"note": "Contract Note",
"status": "Active",
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"start_date": "2020-01-01T00:00:00-00:00",
"end_date": "2030-01-01T00:00:00-00:00",
"tags": [
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
},
{
"id": null,
"name": "tag name",
"taggings_count": 1
}
],
"items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/contracts/{id}/items.json": {
"post": {
"tags": [
"Contract"
],
"operationId": "createItem",
"description": "The parameters and request body are for method: createItem. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"qty": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
},
"example": {
"item": {
"id": null,
"name": "Item Name",
"version": "1",
"qty": "1",
"tag": "Item tag"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/contracts/{contractId}/items/{itemId}.json": {
"put": {
"tags": [
"Contract"
],
"operationId": "updateItemById",
"description": "The parameters and request body are for method: updateItemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"qty": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
},
"example": {
"item": {
"id": null,
"name": "Item Name",
"version": "1",
"qty": "1",
"tag": "Item tag"
}
}
}
}
}
},
"parameters": [
{
"name": "contractId",
"in": "path",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "itemId",
"in": "path",
"required": true,
"schema": {
"title": "itemId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Contract"
],
"operationId": "deleteitemById",
"description": "The parameters and request body are for method: deleteitemById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted item"
}
}
}
}
}
},
"parameters": [
{
"name": "contractId",
"in": "path",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "itemId",
"in": "path",
"required": true,
"schema": {
"title": "itemId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/purchase_orders/{id}.json": {
"get": {
"tags": [
"PurchaseOrder"
],
"operationId": "getPurchaseOrderById",
"description": "The parameters and request body are for method: getPurchaseOrderById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"purchase_order": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"order_date": {
"type": "string"
},
"due_date": {
"type": "string"
},
"buyer": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"state": {
"type": "string"
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"recurrence": {
"type": "string"
},
"total_cost": {
"type": "string"
},
"currency": {
"type": "string"
},
"notes": {
"type": "string"
},
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"billing_address": {
"type": "string"
},
"shiping_address": {
"type": "string"
},
"payment_terms": {
"type": "string"
},
"terms_conditions": {
"type": "string"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"purchase_order_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"quantity": {
"type": "string"
},
"notes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"purchase_order": {
"id": null,
"name": "Purchase order Name",
"order_date": "2025-01-01T00:00:00.000+01:00",
"due_date": "2030-01-01T00:00:00.000+01:00",
"buyer": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"site": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"department": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"state": "Approved",
"requester": {
"id": "1",
"name": "John Doe",
"href": "/users/1"
},
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"billing_address": "Billing address",
"shiping_address": "Shiping address",
"payment_terms": "Purchase terms",
"terms_conditions": "Terms conditions",
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"purchase_order_items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"PurchaseOrder"
],
"operationId": "updatePurchaseOrderById",
"description": "The parameters and request body are for method: updatePurchaseOrderById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"purchase_order": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"order_date": {
"type": "string"
},
"due_date": {
"type": "string"
},
"buyer": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"state": {
"type": "string"
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"recurrence": {
"type": "string"
},
"total_cost": {
"type": "string"
},
"currency": {
"type": "string"
},
"notes": {
"type": "string"
},
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"billing_address": {
"type": "string"
},
"shiping_address": {
"type": "string"
},
"payment_terms": {
"type": "string"
},
"terms_conditions": {
"type": "string"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"purchase_order_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"quantity": {
"type": "string"
},
"notes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"purchase_order": {
"id": null,
"name": "Purchase order Name",
"order_date": "2025-01-01T00:00:00.000+01:00",
"due_date": "2030-01-01T00:00:00.000+01:00",
"buyer": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"site": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"department": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"state": "Approved",
"requester": {
"id": "1",
"name": "John Doe",
"href": "/users/1"
},
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"billing_address": "Billing address",
"shiping_address": "Shiping address",
"payment_terms": "Purchase terms",
"terms_conditions": "Terms conditions",
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"purchase_order_items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"PurchaseOrder"
],
"operationId": "deletePurchaseOrderById",
"description": "The parameters and request body are for method: deletePurchaseOrderById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/purchase_orders.json": {
"get": {
"tags": [
"PurchaseOrder"
],
"operationId": "getCPurchaseOrders",
"description": "The parameters and request body are for method: getCPurchaseOrders. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"purchase_order": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"order_date": {
"type": "string"
},
"due_date": {
"type": "string"
},
"buyer": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"state": {
"type": "string"
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"recurrence": {
"type": "string"
},
"total_cost": {
"type": "string"
},
"currency": {
"type": "string"
},
"notes": {
"type": "string"
},
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"billing_address": {
"type": "string"
},
"shiping_address": {
"type": "string"
},
"payment_terms": {
"type": "string"
},
"terms_conditions": {
"type": "string"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"purchase_order_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"quantity": {
"type": "string"
},
"notes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": [
{
"purchase_order": {
"id": null,
"name": "Purchase order Name",
"order_date": "2025-01-01T00:00:00.000+01:00",
"due_date": "2030-01-01T00:00:00.000+01:00",
"buyer": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"site": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"department": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"state": "Approved",
"requester": {
"id": "1",
"name": "John Doe",
"href": "/users/1"
},
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"billing_address": "Billing address",
"shiping_address": "Shiping address",
"payment_terms": "Purchase terms",
"terms_conditions": "Terms conditions",
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"purchase_order_items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
},
{
"purchase_order": {
"id": null,
"name": "Purchase order Name",
"order_date": "2025-01-01T00:00:00.000+01:00",
"due_date": "2030-01-01T00:00:00.000+01:00",
"buyer": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"site": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"department": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"state": "Approved",
"requester": {
"id": "1",
"name": "John Doe",
"href": "/users/1"
},
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"billing_address": "Billing address",
"shiping_address": "Shiping address",
"payment_terms": "Purchase terms",
"terms_conditions": "Terms conditions",
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"purchase_order_items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
},
{
"purchase_order": {
"id": null,
"name": "Purchase order Name",
"order_date": "2025-01-01T00:00:00.000+01:00",
"due_date": "2030-01-01T00:00:00.000+01:00",
"buyer": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"site": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"department": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"state": "Approved",
"requester": {
"id": "1",
"name": "John Doe",
"href": "/users/1"
},
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"billing_address": "Billing address",
"shiping_address": "Shiping address",
"payment_terms": "Purchase terms",
"terms_conditions": "Terms conditions",
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"purchase_order_items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
},
{
"purchase_order": {
"id": null,
"name": "Purchase order Name",
"order_date": "2025-01-01T00:00:00.000+01:00",
"due_date": "2030-01-01T00:00:00.000+01:00",
"buyer": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"site": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"department": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"state": "Approved",
"requester": {
"id": "1",
"name": "John Doe",
"href": "/users/1"
},
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"billing_address": "Billing address",
"shiping_address": "Shiping address",
"payment_terms": "Purchase terms",
"terms_conditions": "Terms conditions",
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"purchase_order_items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"PurchaseOrder"
],
"operationId": "createPurchaseOrder",
"description": "The parameters and request body are for method: createPurchaseOrder. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"purchase_order": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"order_date": {
"type": "string"
},
"due_date": {
"type": "string"
},
"buyer": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"state": {
"type": "string"
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"recurrence": {
"type": "string"
},
"total_cost": {
"type": "string"
},
"currency": {
"type": "string"
},
"notes": {
"type": "string"
},
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"billing_address": {
"type": "string"
},
"shiping_address": {
"type": "string"
},
"payment_terms": {
"type": "string"
},
"terms_conditions": {
"type": "string"
},
"custom_fields_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"custom_field_id": {
"type": "object"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
}
},
"purchase_order_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"quantity": {
"type": "string"
},
"notes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"purchase_order": {
"id": null,
"name": "Purchase order Name",
"order_date": "2025-01-01T00:00:00.000+01:00",
"due_date": "2030-01-01T00:00:00.000+01:00",
"buyer": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"site": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"department": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"state": "Approved",
"requester": {
"id": "1",
"name": "John Doe",
"href": "/users/1"
},
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Object Name",
"href": "/objects/1"
},
"billing_address": "Billing address",
"shiping_address": "Shiping address",
"payment_terms": "Purchase terms",
"terms_conditions": "Terms conditions",
"custom_fields_values": [
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
},
{
"id": null,
"custom_field_id": null,
"name": " Name of custom text field",
"value": "content",
"type_name": "Text"
}
],
"purchase_order_items": [
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
},
{
"name": "Item Name",
"version": "0.0.0",
"quantity": "1",
"notes": "Item notes",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00",
"tag": "example tag"
}
]
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/vendors/{id}.json": {
"get": {
"tags": [
"Vendor"
],
"operationId": "getVendorById",
"description": "The parameters and request body are for method: getVendorById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"vendor_type": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"url": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_phone": {
"type": "string"
},
"note": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"telephone": {
"type": "string"
}
}
}
}
},
"example": {
"vendor": {
"id": null,
"name": "SolarWinds",
"vendor_type": {
"id": null,
"name": "General Business Vendor"
},
"url": "www.solarwinds.com",
"contact_name": "Support",
"contact_email": "support@solarwinds.com",
"contact_phone": "+000000000",
"note": "Notes",
"address": "Address description",
"city": "Cary",
"state": "NC",
"zip": "USA 11111",
"telephone": "+000000000"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Vendor"
],
"operationId": "updateVendorById",
"description": "The parameters and request body are for method: updateVendorById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"vendor_type": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"url": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_phone": {
"type": "string"
},
"note": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"telephone": {
"type": "string"
}
}
}
}
},
"example": {
"vendor": {
"id": null,
"name": "SolarWinds",
"vendor_type": {
"id": null,
"name": "General Business Vendor"
},
"url": "www.solarwinds.com",
"contact_name": "Support",
"contact_email": "support@solarwinds.com",
"contact_phone": "+000000000",
"note": "Notes",
"address": "Address description",
"city": "Cary",
"state": "NC",
"zip": "USA 11111",
"telephone": "+000000000"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Vendor"
],
"operationId": "deleteVendorById",
"description": "The parameters and request body are for method: deleteVendorById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"deleted_ids": [
"1"
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/vendors.json": {
"get": {
"tags": [
"Vendor"
],
"operationId": "getVendors",
"description": "The parameters and request body are for method: getVendors. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"vendor_type": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"url": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_phone": {
"type": "string"
},
"note": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"telephone": {
"type": "string"
}
}
}
}
}
},
"example": [
{
"vendor": {
"id": null,
"name": "SolarWinds",
"vendor_type": {
"id": null,
"name": "General Business Vendor"
},
"url": "www.solarwinds.com",
"contact_name": "Support",
"contact_email": "support@solarwinds.com",
"contact_phone": "+000000000",
"note": "Notes",
"address": "Address description",
"city": "Cary",
"state": "NC",
"zip": "USA 11111",
"telephone": "+000000000"
}
},
{
"vendor": {
"id": null,
"name": "SolarWinds",
"vendor_type": {
"id": null,
"name": "General Business Vendor"
},
"url": "www.solarwinds.com",
"contact_name": "Support",
"contact_email": "support@solarwinds.com",
"contact_phone": "+000000000",
"note": "Notes",
"address": "Address description",
"city": "Cary",
"state": "NC",
"zip": "USA 11111",
"telephone": "+000000000"
}
},
{
"vendor": {
"id": null,
"name": "SolarWinds",
"vendor_type": {
"id": null,
"name": "General Business Vendor"
},
"url": "www.solarwinds.com",
"contact_name": "Support",
"contact_email": "support@solarwinds.com",
"contact_phone": "+000000000",
"note": "Notes",
"address": "Address description",
"city": "Cary",
"state": "NC",
"zip": "USA 11111",
"telephone": "+000000000"
}
},
{
"vendor": {
"id": null,
"name": "SolarWinds",
"vendor_type": {
"id": null,
"name": "General Business Vendor"
},
"url": "www.solarwinds.com",
"contact_name": "Support",
"contact_email": "support@solarwinds.com",
"contact_phone": "+000000000",
"note": "Notes",
"address": "Address description",
"city": "Cary",
"state": "NC",
"zip": "USA 11111",
"telephone": "+000000000"
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"Vendor"
],
"operationId": "createVendor",
"description": "The parameters and request body are for method: createVendor. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"vendor_type": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"url": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_phone": {
"type": "string"
},
"note": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"telephone": {
"type": "string"
}
}
}
}
},
"example": {
"vendor": {
"id": null,
"name": "SolarWinds",
"vendor_type": {
"id": null,
"name": "General Business Vendor"
},
"url": "www.solarwinds.com",
"contact_name": "Support",
"contact_email": "support@solarwinds.com",
"contact_phone": "+000000000",
"note": "Notes",
"address": "Address description",
"city": "Cary",
"state": "NC",
"zip": "USA 11111",
"telephone": "+000000000"
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/{objectType}/{id}/tasks.json": {
"post": {
"tags": [
"Task"
],
"operationId": "createTask",
"description": "The parameters and request body are for method: createTask. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"task": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"due_at": {
"type": "string"
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"class": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"task": {
"id": null,
"name": "Task Name",
"due_at": "2030-01-01T00:00:00.000+01:00",
"requester": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": false,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"assignee": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"parent": {
"id": null,
"class": "Incident"
}
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/{objectType}/{id}/tasks/{taskId}.json": {
"put": {
"tags": [
"Task"
],
"operationId": "updateTaskById",
"description": "The parameters and request body are for method: updateTaskById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"task": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"due_at": {
"type": "string"
},
"requester": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"group_id": {
"type": "object"
},
"is_user": {
"type": "object"
},
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"class": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"task": {
"id": null,
"name": "Task Name",
"due_at": "2030-01-01T00:00:00.000+01:00",
"requester": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": true,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"assignee": {
"group_id": null,
"is_user": null,
"id": null,
"name": "John Doe",
"email": "john.doe@email.com",
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"parent": {
"id": null,
"class": "Incident"
}
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"title": "taskId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Task"
],
"operationId": "deleteTaskById",
"description": "The parameters and request body are for method: deleteTaskById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted task"
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"title": "taskId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/{objectType}/{id}/comments.json": {
"post": {
"tags": [
"Comment"
],
"operationId": "createComment",
"description": "The parameters and request body are for method: createComment. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"body": {
"type": "string"
},
"is_private": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"commenter_id": {
"type": "object"
},
"commenter_type": {
"type": "string"
}
}
}
}
},
"example": {
"comment": {
"id": null,
"body": "Comment body",
"is_private": "true",
"created_at": "2025-01-01T00:00:00.000+01:00",
"updated_at": "2025-01-01T00:00:00.000+01:00",
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": false,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"commenter_id": null,
"commenter_type": "Incident"
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/{objectType}/{id}/comments/{commentId}.json": {
"put": {
"tags": [
"Comment"
],
"operationId": "updateCommentById",
"description": "The parameters and request body are for method: updateCommentById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"body": {
"type": "string"
},
"is_private": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"commenter_id": {
"type": "object"
},
"commenter_type": {
"type": "string"
}
}
}
}
},
"example": {
"comment": {
"id": null,
"body": "Comment body",
"is_private": "true",
"created_at": "2025-01-01T00:00:00.000+01:00",
"updated_at": "2025-01-01T00:00:00.000+01:00",
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": false,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"commenter_id": null,
"commenter_type": "Incident"
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "commentId",
"in": "path",
"required": true,
"schema": {
"title": "commentId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Comment"
],
"operationId": "deleteCommentById",
"description": "The parameters and request body are for method: deleteCommentById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted comment"
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "commentId",
"in": "path",
"required": true,
"schema": {
"title": "commentId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/{objectType}/{id}/time_tracks.json": {
"get": {
"tags": [
"TimeTrack"
],
"operationId": "getTimeTracks",
"description": "The parameters and request body are for method: getTimeTracks. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"time_track": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"minutes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"class": {
"type": "string"
}
}
}
}
}
}
}
},
"example": [
{
"time_track": {
"id": null,
"name": "Time Track Name",
"minutes": "120",
"created_at": "2025-01-01T00:00:00.000+01:00",
"updated_at": "2025-01-01T00:00:00.000+01:00",
"creator": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": true,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"parent": {
"id": null,
"class": "Incident"
}
}
}
]
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"TimeTrack"
],
"operationId": "createTimeTrack",
"description": "The parameters and request body are for method: createTimeTrack. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"time_track": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"minutes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"class": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"time_track": {
"id": null,
"name": "Time Track Name",
"minutes": "120",
"created_at": "2025-01-01T00:00:00.000+01:00",
"updated_at": "2025-01-01T00:00:00.000+01:00",
"creator": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": true,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"parent": {
"id": null,
"class": "Incident"
}
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/{objectType}/{id}/time_tracks/{timeTrackId}.json": {
"put": {
"tags": [
"TimeTrack"
],
"operationId": "updateTimeTrackyById",
"description": "The parameters and request body are for method: updateTimeTrackyById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"time_track": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"minutes": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"class": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"time_track": {
"id": null,
"name": "Time Track Name",
"minutes": "120",
"created_at": "2025-01-01T00:00:00.000+01:00",
"updated_at": "2025-01-01T00:00:00.000+01:00",
"creator": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": true,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"parent": {
"id": null,
"class": "Incident"
}
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "timeTrackId",
"in": "path",
"required": true,
"schema": {
"title": "timeTrackId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"TimeTrack"
],
"operationId": "deleteTimeTrackyById",
"description": "The parameters and request body are for method: deleteTimeTrackyById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted time track"
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "timeTrackId",
"in": "path",
"required": true,
"schema": {
"title": "timeTrackId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/{objectType}/{id}/purchases.json": {
"post": {
"tags": [
"Purchase"
],
"operationId": "createPurchase",
"description": "The parameters and request body are for method: createPurchase. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"purchase": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"number": {
"type": "string"
},
"date": {
"type": "string"
},
"recurrence": {
"type": "string"
},
"total_cost": {
"type": "string"
},
"currency": {
"type": "string"
},
"notes": {
"type": "string"
},
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"country": {
"type": "string"
},
"city": {
"type": "string"
},
"zip": {
"type": "string"
},
"tech_support": {
"type": "string"
},
"business_phone": {
"type": "string"
},
"url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"purchase": {
"id": null,
"number": "1",
"date": "Jan 01, 2025",
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Google",
"address": "address description",
"country": "US",
"city": "Texas",
"zip": "1",
"tech_support": "+000000000",
"business_phone": "+000000000",
"url": "www.google.com",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00"
}
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/{objectType}/{id}/purchases/{purchaseId}.json": {
"put": {
"tags": [
"Purchase"
],
"operationId": "updatePurchaseById",
"description": "The parameters and request body are for method: updatePurchaseById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"purchase": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"number": {
"type": "string"
},
"date": {
"type": "string"
},
"recurrence": {
"type": "string"
},
"total_cost": {
"type": "string"
},
"currency": {
"type": "string"
},
"notes": {
"type": "string"
},
"vendor": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"country": {
"type": "string"
},
"city": {
"type": "string"
},
"zip": {
"type": "string"
},
"tech_support": {
"type": "string"
},
"business_phone": {
"type": "string"
},
"url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"purchase": {
"id": null,
"number": "1",
"date": "Jan 01, 2025",
"recurrence": "Monthly",
"total_cost": "1",
"currency": "USD",
"notes": "Purchase notes",
"vendor": {
"id": null,
"name": "Google",
"address": "address description",
"country": "US",
"city": "Texas",
"zip": "1",
"tech_support": "+000000000",
"business_phone": "+000000000",
"url": "www.google.com",
"created_at": "2020-01-01T00:00:00.000+01:00",
"updated_at": "2020-10-01T00:00:00.000+01:00"
}
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "purchaseId",
"in": "path",
"required": true,
"schema": {
"title": "purchaseId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Purchase"
],
"operationId": "deletePurchaseById",
"description": "The parameters and request body are for method: deletePurchaseById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted purchase"
}
}
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "purchaseId",
"in": "path",
"required": true,
"schema": {
"title": "purchaseId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/memberships.json": {
"post": {
"tags": [
"Membership"
],
"operationId": "createMembership",
"description": "The parameters and request body are for method: createMembership. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "groupId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userIds",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/memberships/{id}.json": {
"delete": {
"tags": [
"Membership"
],
"operationId": "deleteMemebershipById",
"description": "The parameters and request body are for method: deleteMemebershipById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
},
"example": {
"messages": {
"message": "Deleted membership"
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/audits.json": {
"get": {
"tags": [
"Audit"
],
"operationId": "getAudits",
"description": "The parameters and request body are for method: getAudits. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"audit": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"message": {
"type": "string"
},
"action": {
"type": "string"
},
"created_at": {
"type": "string"
},
"source_type": {
"type": "string"
},
"source_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"note": {
"type": "string"
}
}
}
}
}
},
"example": [
{
"audit": {
"id": null,
"message": "State changed from New to On Hold",
"action": "Update",
"created_at": "2025-01-01T00:00:00.000+01:00",
"source_type": "Incident",
"source_id": null,
"user_id": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": false,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"note": "Audit note"
}
},
{
"audit": {
"id": null,
"message": "State changed from New to On Hold",
"action": "Update",
"created_at": "2025-01-01T00:00:00.000+01:00",
"source_type": "Incident",
"source_id": null,
"user_id": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": true,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"note": "Audit note"
}
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/{objectType}/{id}/audits.json": {
"get": {
"tags": [
"Audit"
],
"operationId": "getAuditById",
"description": "The parameters and request body are for method: getAuditById. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"audit": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"message": {
"type": "string"
},
"action": {
"type": "string"
},
"created_at": {
"type": "string"
},
"source_type": {
"type": "string"
},
"source_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"account_id": {
"type": "object"
},
"user_id": {
"type": "object"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"avatar": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"default_assignee_id": {
"type": "object"
}
}
},
"note": {
"type": "string"
}
}
}
}
}
},
"example": [
{
"audit": {
"id": null,
"message": "State changed from New to On Hold",
"action": "Update",
"created_at": "2025-01-01T00:00:00.000+01:00",
"source_type": "Incident",
"source_id": null,
"user_id": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": true,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"note": "Audit note"
}
},
{
"audit": {
"id": null,
"message": "State changed from New to On Hold",
"action": "Update",
"created_at": "2025-01-01T00:00:00.000+01:00",
"source_type": "Incident",
"source_id": null,
"user_id": null,
"user": {
"id": null,
"account_id": null,
"user_id": null,
"email": "john.doe@email.com",
"name": "John Doe",
"disabled": false,
"avatar": {
"type": "initials",
"color": "#1000",
"initials": "JD"
}
},
"site": {
"id": null,
"name": "Austin TX, USA",
"description": "AUS",
"location": "AUS",
"timezone": "UTC-6h"
},
"department": {
"id": null,
"name": "Support",
"description": "Support Department",
"default_assignee_id": null
},
"note": "Audit note"
}
}
]
}
}
}
},
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/risks.json": {
"get": {
"tags": [
"Risk"
],
"operationId": "getRisks",
"description": "The parameters and request body are for method: getRisks. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"discarded": {
"type": "boolean"
},
"resolved": {
"type": "boolean"
},
"affected_assets": {
"type": "object",
"properties": {
"id": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"created_at": {
"type": "string"
},
"updated at": {
"type": "string"
}
}
}
},
"example": [
{
"id": null,
"name": "Risk name",
"severity": "Medium",
"category": "Inventory",
"discarded": true,
"resolved": true,
"affected_assets": {
"id": null,
"name": "Computer name",
"type": "Hardware"
},
"created_at": "2025-01-01T00:00:00.000+01:00",
"updated at": "2025-01-01T00:00:00.000+01:00"
},
{
"id": null,
"name": "Risk name",
"severity": "Medium",
"category": "Inventory",
"discarded": true,
"resolved": false,
"affected_assets": {
"id": null,
"name": "Computer name",
"type": "Hardware"
},
"created_at": "2025-01-01T00:00:00.000+01:00",
"updated at": "2025-01-01T00:00:00.000+01:00"
},
{
"id": null,
"name": "Risk name",
"severity": "Medium",
"category": "Inventory",
"discarded": true,
"resolved": true,
"affected_assets": {
"id": null,
"name": "Computer name",
"type": "Hardware"
},
"created_at": "2025-01-01T00:00:00.000+01:00",
"updated at": "2025-01-01T00:00:00.000+01:00"
}
]
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/attachments.json": {
"post": {
"tags": [
"Attachment"
],
"operationId": "createAttachment",
"description": "The parameters and request body are for method: createAttachment. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
}
},
"components": {
"schemas": {}
}
}