Retrieve Integration

GET

Retrieves an Integration specified by a unique identifier.

The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager’s sales team to request use of this API.

Path parameters

integrationIdstringRequired

The unique identifier of this Integration

Headers

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

Response

Success

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

dataobjectOptional

The Integrations API is intended for use by ProjectManager and its business development partners. Please contact ProjectManager’s sales team to request use of this API.

GET

1 curl https://api.projectmanager.com/api/data/integrations/integrationId \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "error": {
3     "technicalError": "technicalError",
4     "additionalErrors": [
5       "additionalErrors"
6     ],
7     "validationErrors": {
8       "key": [
9         "value"
10       ]
11     },
12     "message": "message"
13   },
14   "success": true,
15   "hasError": true,
16   "statusCode": "Continue",
17   "data": {
18     "id": "id",
19     "name": "name",
20     "description": "description",
21     "shortId": "shortId",
22     "isMultiInstance": true,
23     "config": {
24       "key": "value"
25     },
26     "licenseSkus": [
27       "licenseSkus"
28     ],
29     "instances": [
30       {}
31     ],
32     "enabled": true,
33     "authenticated": true,
34     "autoEnabled": true,
35     "noAdminPermission": true
36   }
37 }

Enable Integration

Up Next

Built with

1	curl https://api.projectmanager.com/api/data/integrations/integrationId \
2	-H "Authorization: Bearer <token>"

1	{
2	"error": {
3	"technicalError": "technicalError",
4	"additionalErrors": [
5	"additionalErrors"
6	],
7	"validationErrors": {
8	"key": [
9	"value"
10	]
11	},
12	"message": "message"
13	},
14	"success": true,
15	"hasError": true,
16	"statusCode": "Continue",
17	"data": {
18	"id": "id",
19	"name": "name",
20	"description": "description",
21	"shortId": "shortId",
22	"isMultiInstance": true,
23	"config": {
24	"key": "value"
25	},
26	"licenseSkus": [
27	"licenseSkus"
28	],
29	"instances": [
30	{}
31	],
32	"enabled": true,
33	"authenticated": true,
34	"autoEnabled": true,
35	"noAdminPermission": true
36	}
37	}