Skip to content

Commit a2708e0

Browse files
howellchrisjhowellchrisj
authored
ConnectWise PSA (Independent Publisher) (#3883)
* Create README.md * Update README.md * Screenshot * ConnectWise API Connector * Add files via upload * Update README.md * Add files via upload * Delete independent-publisher-connectors/Proposal - ConnectWise (Independent Publisher)/apiDefinition.swagger.json * Rename ConnectWise-API-Connector.swagger.json to apiDefinition.swagger.json * Add files via upload * Delete independent-publisher-connectors/Proposal - ConnectWise (Independent Publisher)/independent-publisher-icon.png * Delete independent-publisher-connectors/Proposal - ConnectWise (Independent Publisher)/ConnectWise API Connector 1.png * Delete independent-publisher-connectors/Proposal - ConnectWise (Independent Publisher)/ConnectWise API Connector 2.png * Add files via upload * Add files via upload * Update README.md * Update apiDefinition.swagger.json * Update apiDefinition.swagger.json * Add files via upload * Update apiDefinition.swagger.json Added Metadata section * Add files via upload * Create README.md * Add files via upload * Delete independent-publisher-connectors/Proposal - ConnectWise (Independent Publisher)/apiProperties.json * Delete independent-publisher-connectors/Proposal - ConnectWise (Independent Publisher)/README.md * Delete independent-publisher-connectors/Proposal - ConnectWise (Independent Publisher)/apiDefinition.swagger.json * Delete independent-publisher-connectors/README.md * Update apiDefinition.swagger.json * Update apiProperties.json * Update apiProperties.json * Update apiProperties.json Trying to get the Authentication to appear in CW Connector * Update apiProperties.json * Update apiDefinition.swagger.json * Update apiDefinition.swagger.json Corrected swagger issues * Update apiProperties.json * Update apiProperties.json * Update apiDefinition.swagger.json * Update apiProperties.json * Update apiDefinition.swagger.json * Update apiProperties.json * Update apiDefinition.swagger.json * Update apiProperties.json
1 parent 83e5042 commit a2708e0

File tree

2 files changed

+197
-193
lines changed

2 files changed

+197
-193
lines changed

‎independent-publisher-connectors/ConnectWise PSA (Independent Publisher)/apiDefinition.swagger.json‎

Lines changed: 193 additions & 177 deletions
Original file line numberDiff line numberDiff line change
@@ -1,190 +1,206 @@
11
{
2-
"swagger": "2.0",
3-
"info": {
4-
"version": "1.0.0",
5-
"title": "ConnectWise PSA",
6-
"description": "ConnectWise PSA - This connector is designed to aid in the Creation, Updating, and Selection of records from ConnectWise",
7-
"contact": {
8-
"name": "Support",
9-
"url": "https://www.opalbiz.com",
10-
"email": "[email protected]"
11-
}
12-
},
13-
"host": "api-na.myconnectwise.net",
14-
"basePath": "/",
15-
"schemes": ["https"],
16-
"consumes": ["application/json"],
17-
"produces": ["application/json"],
18-
"paths": {
19-
"/v4_6_release/apis/3.0/service/tickets": {
20-
"get": {
21-
"summary": "GetTickets",
22-
"operationId": "GetTickets",
23-
"description": "Get Ticket Details based on Conditions and selecting certain fields",
24-
"parameters": [
25-
{
26-
"name": "conditions",
27-
"in": "query",
28-
"required": false,
29-
"type": "string",
30-
"description": "Filters for retrieving tickets based on specific conditions.",
31-
"x-ms-summary": "Ticket Conditions"
32-
},
33-
{
34-
"name": "fields",
35-
"in": "query",
36-
"required": false,
37-
"type": "string",
38-
"description": "Comma-separated list of fields to include in the response.",
39-
"x-ms-summary": "Fields to Retrieve"
40-
},
41-
{
42-
"name": "Authorization",
43-
"in": "header",
44-
"required": true,
45-
"type": "string",
46-
"x-ms-parameter-location": "client",
47-
"description": "API Key used for authentication.",
48-
"x-ms-summary": "Authorization Header"
49-
},
50-
{
51-
"name": "ClientID",
52-
"in": "header",
53-
"required": true,
54-
"type": "string",
55-
"x-ms-parameter-location": "client",
56-
"description": "The Client ID used for API authentication.",
57-
"x-ms-summary": "Client ID Header"
58-
}
59-
],
60-
"responses": {
61-
"default": {
62-
"description": "default"
63-
}
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "1.0.0",
5+
"title": "ConnectWise PSA",
6+
"description": "ConnectWise PSA - This connector is designed to aid in the Creation, Updating, and Selection of records from ConnectWise",
7+
"contact": {
8+
"name": "Support",
9+
"url": "https://www.opalbiz.com",
10+
"email": "[email protected]"
6411
}
65-
},
66-
"post": {
67-
"summary": "Create Service Ticket",
68-
"operationId": "CreateServiceTicket",
69-
"description": "Create Service Ticket in ConnectWise",
70-
"parameters": [
71-
{
72-
"name": "Authorization",
73-
"in": "header",
74-
"required": true,
75-
"type": "string",
76-
"x-ms-parameter-location": "client",
77-
"description": "API Key used for authentication.",
78-
"x-ms-summary": "Authorization Header"
79-
},
80-
{
81-
"name": "ClientID",
82-
"in": "header",
83-
"required": true,
84-
"type": "string",
85-
"x-ms-parameter-location": "client",
86-
"description": "Client ID used for API authentication.",
87-
"x-ms-summary": "Client ID Header"
88-
},
89-
{
90-
"name": "body",
91-
"in": "body",
92-
"required": true,
93-
"x-ms-summary": "Ticket Payload",
94-
"schema": {
95-
"type": "object",
96-
"properties": {
97-
"id": {
98-
"type": "integer",
99-
"format": "int32",
100-
"description": "The unique identifier of the ticket."
101-
},
102-
"summary": {
103-
"type": "string",
104-
"description": "A brief description of the ticket."
105-
},
106-
"board": {
107-
"type": "object",
108-
"properties": {
109-
"id": {
110-
"type": "integer",
111-
"format": "int32",
112-
"description": "The unique identifier of the board."
12+
},
13+
"basePath": "/",
14+
"host": "api-na.myconnectwise.net",
15+
"schemes": [
16+
"https"
17+
],
18+
"consumes": [
19+
"application/json"
20+
],
21+
"produces": [
22+
"application/json"
23+
],
24+
"paths": {
25+
"/v4_6_release/apis/3.0/service/tickets": {
26+
"get": {
27+
"summary": "GetTickets",
28+
"operationId": "GetTickets",
29+
"description": "Get Ticket Details based on Conditions and selecting certain fields",
30+
"parameters": [
31+
{
32+
"name": "conditions",
33+
"in": "query",
34+
"required": false,
35+
"type": "string",
36+
"description": "Filters for retrieving tickets based on specific conditions.",
37+
"x-ms-summary": "Ticket Conditions"
11338
},
114-
"name": {
115-
"type": "string",
116-
"description": "The name of the board."
117-
}
118-
},
119-
"description": "Details of the board associated with the ticket."
120-
},
121-
"status": {
122-
"type": "object",
123-
"properties": {
124-
"id": {
125-
"type": "integer",
126-
"format": "int32",
127-
"description": "The unique identifier of the status."
39+
{
40+
"name": "fields",
41+
"in": "query",
42+
"required": false,
43+
"type": "string",
44+
"description": "Comma-separated list of fields to include in the response.",
45+
"x-ms-summary": "Fields to Retrieve"
12846
},
129-
"name": {
130-
"type": "string",
131-
"description": "The name of the status."
47+
{
48+
"name": "ClientID",
49+
"in": "header",
50+
"required": true,
51+
"type": "string",
52+
"description": "Your ConnectWise Client ID",
53+
"x-ms-summary": "Client ID Header"
54+
}
55+
],
56+
"responses": {
57+
"default": {
58+
"x-ms-parameter-location": "client",
59+
"description": "The Client ID used for API authentication.",
60+
"x-ms-summary": "Client ID Header"
13261
}
133-
},
134-
"description": "Status information for the ticket."
13562
},
136-
"company": {
137-
"type": "object",
138-
"properties": {
139-
"id": {
140-
"type": "integer",
141-
"format": "int32",
142-
"description": "The unique identifier of the company."
63+
"consumes": [
64+
"application/json"
65+
],
66+
"produces": [
67+
"application/json"
68+
]
69+
},
70+
"post": {
71+
"summary": "Create Service Ticket",
72+
"operationId": "CreateServiceTicket",
73+
"description": "Create Service Ticket in ConnectWise",
74+
"parameters": [
75+
{
76+
"name": "ClientID",
77+
"in": "header",
78+
"required": true,
79+
"type": "string",
80+
"x-ms-parameter-location": "client",
81+
"description": "Client ID used for API authentication.",
82+
"x-ms-summary": "Client ID Header"
14383
},
144-
"name": {
145-
"type": "string",
146-
"description": "The name of the company."
84+
{
85+
"name": "body",
86+
"in": "body",
87+
"required": true,
88+
"x-ms-summary": "Ticket Payload",
89+
"schema": {
90+
"type": "object",
91+
"properties": {
92+
"id": {
93+
"type": "integer",
94+
"format": "int32",
95+
"description": "The unique identifier of the ticket."
96+
},
97+
"summary": {
98+
"type": "string",
99+
"description": "A brief description of the ticket."
100+
},
101+
"board": {
102+
"type": "object",
103+
"properties": {
104+
"id": {
105+
"type": "integer",
106+
"format": "int32",
107+
"description": "The unique identifier of the board."
108+
},
109+
"name": {
110+
"type": "string",
111+
"description": "The name of the board."
112+
}
113+
},
114+
"description": "Details of the board associated with the ticket."
115+
},
116+
"status": {
117+
"type": "object",
118+
"properties": {
119+
"id": {
120+
"type": "integer",
121+
"format": "int32",
122+
"description": "The unique identifier of the status."
123+
},
124+
"name": {
125+
"type": "string",
126+
"description": "The name of the status."
127+
}
128+
},
129+
"description": "Status information for the ticket."
130+
},
131+
"company": {
132+
"type": "object",
133+
"properties": {
134+
"id": {
135+
"type": "integer",
136+
"format": "int32",
137+
"description": "The unique identifier of the company."
138+
},
139+
"name": {
140+
"type": "string",
141+
"description": "The name of the company."
142+
}
143+
},
144+
"description": "Company details related to the ticket."
145+
}
146+
}
147+
}
148+
}
149+
],
150+
"responses": {
151+
"default": {
152+
"description": "default"
147153
}
148-
},
149-
"description": "Company details related to the ticket."
150-
}
151-
}
154+
},
155+
"consumes": [
156+
"application/json"
157+
],
158+
"produces": [
159+
"application/json"
160+
]
152161
}
153-
}
154-
],
155-
"responses": {
156-
"default": {
157-
"description": "default"
158-
}
159162
}
160-
}
161-
}
162-
},
163-
"securityDefinitions": {
164-
"api_key": {
165-
"type": "apiKey",
166-
"in": "header",
167-
"name": "Authorization"
168-
}
169-
},
170-
"security": [
171-
{
172-
"api_key": []
173-
}
174-
],
175-
"tags": [],
176-
"x-ms-connector-metadata": [
177-
{
178-
"propertyName": "Website",
179-
"propertyValue": "https://www.opalbiz.com"
180163
},
181-
{
182-
"propertyName": "Privacy policy",
183-
"propertyValue": "https://www.opalbiz.com"
164+
"tags": [],
165+
"x-ms-connector-metadata": [
166+
{
167+
"propertyName": "Website",
168+
"propertyValue": "https://www.opalbiz.com"
169+
},
170+
{
171+
"propertyName": "Privacy policy",
172+
"propertyValue": "https://www.opalbiz.com"
173+
},
174+
{
175+
"propertyName": "Categories",
176+
"propertyValue": "Data"
177+
}
178+
],
179+
"x-ms-parameterized-host": {
180+
"hostTemplate": "{regionHost}",
181+
"useSchemePrefix": true,
182+
"parameters": [
183+
{
184+
"name": "regionHost",
185+
"type": "string",
186+
"x-ms-parameter-location": "client",
187+
"defaultValue": "api-na.myconnectwise.net",
188+
"required": true,
189+
"description": "Enter the region-specific ConnectWise API domain, like api-na.myconnectwise.net or api-eu.myconnectwise.net",
190+
"x-ms-summary": "ConnectWise Region Host"
191+
}
192+
]
193+
},
194+
"securityDefinitions": {
195+
"api_key": {
196+
"type": "apiKey",
197+
"in": "header",
198+
"name": "Authorization"
199+
}
184200
},
185-
{
186-
"propertyName": "Categories",
187-
"propertyValue": "Data"
188-
}
189-
]
201+
"security": [
202+
{
203+
"api_key": []
204+
}
205+
]
190206
}

0 commit comments

Comments
 (0)