@itentialopensource/adapter-service_desk_plus

{ "openapi": "3.0.2", "info": { "title": "service_desk_plus", "version": "0.0.1", "description": "REST API for Service Desk Plus by ManageEngine.\nMaintained by Itential LLC", "termsOfService": "http://swagger.io/terms/", "contact": { "name": "Itential LLC", "url": "https://www.itential.com/products/adapters-library/", "email": "info@itential.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "paths": { "/api/v3/requests": { "get": { "tags": [ "request" ], "summary": "Retrieve Requests", "description": "Retrieve Requests", "operationId": "getRequests", "parameters": [], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "tags": [ "request" ], "summary": "This operation helps you to add new requests.", "description": "This operation helps you to add new requests.\nhttps://ui.servicedeskplus.com/APIDocs3/index.html#add-request", "operationId": "postAddRequest", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "success creating a new Request" } } } }, "/api/v3/requests/{request_id}": { "get": { "tags": [ "request" ], "summary": "Retrieve Specific Request", "description": "Retrieve Specific Request", "operationId": "getRequestById", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "put": { "tags": [ "request" ], "summary": "This operation helps you to update the request by using the unique request_id", "description": "This operation helps you to update the request by using the unique request_id\nhttps://ui.servicedeskplus.com/APIDocs3/index.html#update-request", "operationId": "putUpdateRequest", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "\"status\": \"success\"" } } } }, "/api/v3/requests/{request_id}/summary": { "get": { "tags": [ "request" ], "summary": "Retrieve Request Summary", "description": "Retrieve Request Summary", "operationId": "getRequestSummary", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v3/requests/{request_id}/project": { "post": { "tags": [ "request" ], "summary": "This operation lets you attach a Project to a Request", "description": "This operation lets you attach a Project to a Request\nhttps://ui.servicedeskplus.com/APIDocs3/index.html#associate-project", "operationId": "postAssociateProjectToRequest", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "schema": { "type": "integer" }, "in": "path", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "\"status\": \"success\"" } } } }, "/api/v3/requests/{request_id}/problem": { "get": { "tags": [ "problem" ], "summary": "Retrieve Problems on Request", "description": "Retrieve Problems on Request", "operationId": "getProblemsFromRequest", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "tags": [ "problem" ], "summary": "Associate problem with Request", "description": "Associate problem with Request", "operationId": "associateProblemWithRequest", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "delete": { "tags": [ "problem" ], "summary": "Dissociate problem with Request", "description": "Dissociate problem with Request", "operationId": "dissociateProblemWithRequest", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v3/requests/{request_id}/resolutions": { "get": { "tags": [ "request" ], "summary": "Retrieve Resolutions on Request", "description": "Retrieve Resolutions on Request", "operationId": "getResolutionsFromRequest", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "tags": [ "request" ], "summary": "This Operation allows you to add/update a resolution of the request.", "description": "This Operation allows you to add/update a resolution of the request.\nhttps://ui.servicedeskplus.com/APIDocs3/index.html#add-resolution", "operationId": "postAddResolution", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "schema": { "type": "integer" }, "in": "path", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "warning" } } } }, "/api/v3/requests/{request_id}/assign": { "put": { "tags": [ "request" ], "summary": "Assign Request", "description": "Assign Request", "operationId": "assignRequest", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v3/requests/{request_id}/close": { "put": { "tags": [ "request" ], "summary": "Close Request", "description": "Close Request", "operationId": "closeRequest", "parameters": [ { "name": "request_id", "description": "Id of this request\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/sdpapi/change": { "get": { "tags": [ "change" ], "summary": "Retrieve Changes", "description": "Retrieve Changes", "operationId": "getChanges", "parameters": [], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "tags": [ "change" ], "summary": "Create a Change", "description": "Create a Change", "operationId": "createChange", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v3/requests/{change_id}": { "get": { "tags": [ "change" ], "summary": "Retrieve Specific Change", "description": "Retrieve Specific Change", "operationId": "getChangeById", "parameters": [ { "name": "change_id", "description": "Id of this change\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "put": { "tags": [ "change" ], "summary": "Update a Change", "description": "Update a Change", "operationId": "updateChange", "parameters": [ { "name": "change_id", "description": "Id of this change\n", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" } } } } } } } }, "components": { "schemas": { } } }