Search installed integrations

This endpoint is used to search for installed integrations.

URL

GET https://{api-url}/api/v2/tenants/{clientId}/integrations/installed/search

Sample URLs

https://{api-url}/api/v2/tenants/client_8/integrations/installed/search?pageNo=1&pageSize=10&queryString=category:CUSTOM_INTEGRATION+uId:RESTAPI

https://{api-url}/api/v2/tenants/client_8/integrations/installed/search?pageNo=1&pageSize=10&queryString=category:ITSM_INTEGRATION

Parameters

Field	Default Value
pageNo={pageNo}	1
pageSize={pageSize}	100
isDescendingOrder={true/false}	false
sortName={field}	name
queryString={queryString}	NA

NA indicates that the value is not applicable.

Notes

There are special characters that can be used in a query string:

(+) represents the next field and must be URL-encoded.
(:) represents equals. An example is key : value.
Space characters must be URL-encoded.

Status code

200 OK

Search for a custom integration

Sample URL

https://{api-url}/api/v2/tenants/client_8/integrations/installed/search?pageNo=1&pageSize=10&queryString=category:CUSTOM_INTEGRATION+uId:RESTAPI

Sample response

{
	"results": [{
			"id": "INTG-10eb3495-d68e-d6d7-d177-0bfacf58d061",
			"integration": {
				"id": "RESTAPI",
				"name": "Custom"
			},
			"inboundConfig": {
				"authentication": {
					"authType": "ALL"
				}
			},
			"outboundConfig": {
				"baseNotifier": {
					"baseURI": "sp-config.in",
					"authType": "BASIC",
					"userName": "1234"
				}
			}
		},
		{
			"id": "INTG-15cd3139-00e3-4dbd-8aee-327e3d10e23e",
			"integration": {
				"id": "RESTAPI",
				"name": "Custom"
			},
			"inboundConfig": {
				"authentication": {
					"authType": "WEBHOOK",
					"token": "bp78MehsKbdBgqezZXa2FKJvvXZPnMcC"
				},
				"mapAttributes": [{
					"name": "Status",
					"attrName": "incident.status.name",
					"thirdPartyAttrName": "tren",
					"entityType": "INCIDENT",
					"thirdPartyEntityType": "tree",
					"attrValues": [{
						"attrValue": "New",
						"thirdPartyAttrValue": "new"
					}]
				}]
			},
			"outboundConfig": {
				"baseNotifier": {
					"baseURI": "sp-config.in",
					"authType": "BASIC",
					"userName": "1234"
				}
			}
		}
	],
	"totalResults": 2,
	"pageNo": 1,
	"pageSize": 5,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": false
}

Search for an ITSM integration

Sample URL

https://{api-url}/api/v2/tenants/client_8/integrations/installed/search?pageNo=1&pageSize=10&queryString=category:ITSM_INTEGRATION

Sample response

{
	"results": [{
			"id": "INTG-30afec31-9c37-4784-a6de-051997a5715e",
			"integration": {
				"id": "JIRA",
				"name": "JIRA"
			},
			"inboundConfig": {
				"authentication": {
					"authType": "WEBHOOK",
					"token": "w6bbEcYKnqggCkzPgBg745YXPKs3DuWb"
				},
				"mapAttributes": [{
						"name": "Status",
						"attrName": "serviceRequest.status.name",
						"thirdPartyAttrName": "Status",
						"entityType": "SERVICEREQUEST",
						"thirdPartyEntityType": "SRQ",
						"attrValues": [{
								"attrValue": "Open",
								"thirdPartyAttrValue": "In Progress"
							},
							{
								"attrValue": "Closed",
								"thirdPartyAttrValue": "Completed"
							},
							{
								"attrValue": "Open",
								"thirdPartyAttrValue": "In Progress"
							},
							{
								"attrValue": "Closed",
								"thirdPartyAttrValue": "Completed"
							}
						]
					},
					{
						"name": "Status",
						"attrName": "incident.status.name",
						"thirdPartyAttrName": "Status",
						"entityType": "INCIDENT",
						"thirdPartyEntityType": "TICKET",
						"attrValues": [{
								"attrValue": "Open",
								"thirdPartyAttrValue": "In Progress"
							},
							{
								"attrValue": "Closed",
								"thirdPartyAttrValue": "Completed"
							},
							{
								"attrValue": "Open",
								"thirdPartyAttrValue": "In Progress"
							},
							{
								"attrValue": "Closed",
								"thirdPartyAttrValue": "Completed"
							}
						]
					},
					{
						"name": "Priority",
						"attrName": "incident.priority.name",
						"thirdPartyAttrName": "severity",
						"entityType": "INCIDENT",
						"thirdPartyEntityType": "TICKET",
						"attrValues": [{
								"attrValue": "High",
								"thirdPartyAttrValue": "Max"
							},
							{
								"attrValue": "Low",
								"thirdPartyAttrValue": "min"
							},
							{
								"attrValue": "High",
								"thirdPartyAttrValue": "Max"
							},
							{
								"attrValue": "Low",
								"thirdPartyAttrValue": "min"
							}
						]
					},
					{
						"name": "Priority",
						"attrName": "serviceRequest.priority.name",
						"thirdPartyAttrName": "severity",
						"entityType": "SERVICEREQUEST",
						"thirdPartyEntityType": "SRQ",
						"attrValues": [{
								"attrValue": "High",
								"thirdPartyAttrValue": "Max"
							},
							{
								"attrValue": "Low",
								"thirdPartyAttrValue": "min"
							},
							{
								"attrValue": "High",
								"thirdPartyAttrValue": "Max"
							},
							{
								"attrValue": "Low",
								"thirdPartyAttrValue": "min"
							}
						]
					}
				]
			},
			"outboundConfig": {
				"mapAttributes": [{
						"name": "Status",
						"attrName": "incident.status.name",
						"thirdPartyAttrName": "state",
						"entityType": "INCIDENT",
						"thirdPartyEntityType": "ticket",
						"attrValues": [{
							"attrValue": "Closed",
							"thirdPartyAttrValue": "close"
						}]
					},
					{
						"name": "Priority",
						"attrName": "incident.priority.name",
						"thirdPartyAttrName": "priority",
						"entityType": "INCIDENT",
						"thirdPartyEntityType": "ticket",
						"attrValues": [{
							"attrValue": "Very Low",
							"thirdPartyAttrValue": "low"
						}]
					}
				]
			}
		},
		{
			"id": "INTG-91d0160f-ddd9-7b54-ecd3-581356e2d8de",
			"integration": {
				"id": "EMAILINCIDENTS",
				"name": "Email Requests"
			},
			"outboundConfig": {}
		},
		{
			"id": "INTG-ca260626-8352-7c1f-52a5-71d425439e75",
			"integration": {
				"id": "SLACK",
				"name": "Slack"
			},
			"inboundConfig": {
				"authentication": {
					"authType": "ALL"
				},
				"mapAttributes": [{
					"name": "Status",
					"attrName": "incident.status.name",
					"thirdPartyAttrName": "testin",
					"entityType": "INCIDENT",
					"thirdPartyEntityType": "test",
					"attrValues": [{
						"attrValue": "low",
						"thirdPartyAttrValue": "verylow"
					}]
				}]
			},
			"outboundConfig": {}
		}
	],
	"totalResults": 3,
	"pageNo": 1,
	"pageSize": 5,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": false
}