@itentialopensource/adapter-solarwinds_servicedesk

{ "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": "Equ