diff --git a/independent-publisher-connectors/ConnectWise PSA (Independent Publisher)/apiDefinition.swagger.json b/independent-publisher-connectors/ConnectWise PSA (Independent Publisher)/apiDefinition.swagger.json index bf32ad96ac..de1a015bd0 100644 --- a/independent-publisher-connectors/ConnectWise PSA (Independent Publisher)/apiDefinition.swagger.json +++ b/independent-publisher-connectors/ConnectWise PSA (Independent Publisher)/apiDefinition.swagger.json @@ -1,206 +1,201 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "ConnectWise PSA", - "description": "ConnectWise PSA - This connector is designed to aid in the Creation, Updating, and Selection of records from ConnectWise", - "contact": { - "name": "Support", - "url": "https://www.opalbiz.com", - "email": "CWConnector@opalbiz.com" - } - }, - "basePath": "/", - "host": "api-na.myconnectwise.net", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/v4_6_release/apis/3.0/service/tickets": { - "get": { - "summary": "GetTickets", - "operationId": "GetTickets", - "description": "Get Ticket Details based on Conditions and selecting certain fields", - "parameters": [ - { - "name": "conditions", - "in": "query", - "required": false, - "type": "string", - "description": "Filters for retrieving tickets based on specific conditions.", - "x-ms-summary": "Ticket Conditions" - }, - { - "name": "fields", - "in": "query", - "required": false, - "type": "string", - "description": "Comma-separated list of fields to include in the response.", - "x-ms-summary": "Fields to Retrieve" - }, - { - "name": "ClientID", - "in": "header", - "required": true, - "type": "string", - "description": "Your ConnectWise Client ID", - "x-ms-summary": "Client ID Header" - } - ], - "responses": { - "default": { - "x-ms-parameter-location": "client", - "description": "The Client ID used for API authentication.", - "x-ms-summary": "Client ID Header" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] - }, - "post": { - "summary": "Create Service Ticket", - "operationId": "CreateServiceTicket", - "description": "Create Service Ticket in ConnectWise", - "parameters": [ - { - "name": "ClientID", - "in": "header", - "required": true, - "type": "string", - "x-ms-parameter-location": "client", - "description": "Client ID used for API authentication.", - "x-ms-summary": "Client ID Header" - }, - { - "name": "body", - "in": "body", - "required": true, - "x-ms-summary": "Ticket Payload", - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32", - "description": "The unique identifier of the ticket." - }, - "summary": { - "type": "string", - "description": "A brief description of the ticket." - }, - "board": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32", - "description": "The unique identifier of the board." - }, - "name": { - "type": "string", - "description": "The name of the board." - } - }, - "description": "Details of the board associated with the ticket." - }, - "status": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32", - "description": "The unique identifier of the status." - }, - "name": { - "type": "string", - "description": "The name of the status." - } - }, - "description": "Status information for the ticket." - }, - "company": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32", - "description": "The unique identifier of the company." - }, - "name": { - "type": "string", - "description": "The name of the company." - } - }, - "description": "Company details related to the ticket." - } - } - } - } - ], - "responses": { - "default": { - "description": "default" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] - } - } - }, - "tags": [], - "x-ms-connector-metadata": [ - { - "propertyName": "Website", - "propertyValue": "https://www.opalbiz.com" - }, - { - "propertyName": "Privacy policy", - "propertyValue": "https://www.opalbiz.com" - }, - { - "propertyName": "Categories", - "propertyValue": "Data" - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{regionHost}", - "useSchemePrefix": true, - "parameters": [ - { - "name": "regionHost", - "type": "string", - "x-ms-parameter-location": "client", - "defaultValue": "api-na.myconnectwise.net", - "required": true, - "description": "Enter the region-specific ConnectWise API domain, like api-na.myconnectwise.net or api-eu.myconnectwise.net", - "x-ms-summary": "ConnectWise Region Host" - } - ] - }, - "securityDefinitions": { - "api_key": { - "type": "apiKey", - "in": "header", - "name": "Authorization" - } - }, - "security": [ - { - "api_key": [] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "1.0.0", + "title": "ConnectWise PSA", + "description": "ConnectWise PSA - This connector is designed to aid in the Creation and Selection of Ticket records from ConnectWise", + "contact": { + "name": "Support", + "url": "https://www.opalbiz.com", + "email": "CWConnector@opalbiz.com" + } + }, + "basePath": "/", + "host": "api-na.myconnectwise.net", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/v4_6_release/apis/3.0/service/tickets": { + "get": { + "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket\r\n To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", + "operationId": "getServiceTickets", + "description": "Get List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket\r\n To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", + "parameters": [ + { + "name": "conditions", + "in": "query", + "required": false, + "type": "string", + "description": "", + "x-ms-summary": "conditions" + }, + { + "name": "childConditions", + "in": "query", + "required": false, + "type": "string", + "description": "", + "x-ms-summary": "childConditions" + }, + { + "name": "customFieldConditions", + "in": "query", + "required": false, + "type": "string", + "description": "", + "x-ms-summary": "customFieldConditions" + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "type": "string", + "description": "", + "x-ms-summary": "orderBy" + }, + { + "name": "fields", + "in": "query", + "required": false, + "type": "string", + "description": "", + "x-ms-summary": "fields" + }, + { + "name": "page", + "in": "query", + "required": false, + "type": "integer", + "description": "", + "x-ms-summary": "page" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "description": "", + "x-ms-summary": "pageSize" + }, + { + "name": "pageId", + "in": "query", + "required": false, + "type": "integer", + "description": "", + "x-ms-summary": "pageId" + }, + { + "name": "clientId", + "in": "header", + "required": true, + "type": "string", + "description": "", + "x-ms-summary": "clientId", + "x-ms-parameter-location": "client" + } + ], + "responses": { + "200": { + "description": "List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + }, + + "post": { + "summary": "Post Ticket", + "operationId": "postServiceTickets", + "description": "Post Ticket", + "parameters": [ + { + "name": "clientId", + "in": "header", + "required": true, + "type": "string", + "description": "", + "x-ms-summary": "clientId", + "x-ms-parameter-location": "client" + }, + { + "name": "body", + "in": "body", + "required": true, + "x-ms-summary": "ticket", + "schema": { + "$ref": "#/components/schemas/Ticket" + } + } + ], + "responses": { + "201": { + "description": "Ticket" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + } + + } + }, + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://www.opalbiz.com" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://www.opalbiz.com" + }, + { + "propertyName": "Categories", + "propertyValue": "Data" + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{regionHost}", + "useSchemePrefix": true, + "parameters": [ + { + "name": "regionHost", + "type": "string", + "x-ms-parameter-location": "client", + "defaultValue": "api-na.myconnectwise.net", + "required": true, + "description": "Enter the region-specific ConnectWise API domain, like api-na.myconnectwise.net or api-eu.myconnectwise.net", + "x-ms-summary": "ConnectWise Region Host" + } + ] + }, + "securityDefinitions": { + "api_key": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "api_key": [] + } + ] +} + +