URL

GET https://{api-url}/api/v2/tenants/{tenantId}/escalations/search

Sample URLs

https://{api-url}/api/v2/tenants/msp_5/escalations/search
https://{api-url}/api/v2/tenants/client_7/escalations/search?pageNo=1&pageSize=20&isDescendingOrder=false&sortName=id&queryString=name:Test
https://{api-url}/api/v2/tenants/msp_5/escalations/search?pageNo=1&queryString=name:Test+allList:true

Header format

HeaderValue
AuthorizationBearer {accessToken}
Content-typeapplication/json
Acceptapplication/json

Status code

200 OK

Parameters

All of the following parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariableValuesDescription
nameNAAlert Escalation policy name. Only identical policies in query string name are displayed.
allListtrue, falseThis string is applicable to a partner user to fetch client policies as well. By default, partner alert escalation policies are provided if allList is not provided in the query string.
  • Provide allList: true to fetch partner and client alert escalation policies.
  • Provide allList: false to fetch only partner alert escalation policies.
startCreationDateNASearch for policies created within a certain time frame. Provide a start date.
An example: 2017-05-05T13:25:15 0000
endCreationDateNAProvide an end date.
An example: 2017-05-08T10:30:40 0000
startUpdationDateNASearch for policies updated within a certain time frame. Provide a start date.
An example: 2017-06-10T09:20:10 0000
endUpdationDateNAProvide an end date.
An example: 2017-06-15T08:10:30 0000

Sample response

{
	"results" : [
		{
			"id" : "POLICY-a0250f66-bf3a-7568-edef-83e7e8ac4231",
			"name" : "Copy of Test partner1",
			"description" : "",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-05T13:25:15+0000",
			"updatedDate" : "2017-05-16T04:32:14+0000",
			"active" : false,
			"enabledMode": "OFF",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "client_7",
				"name" : "NE  Client",
				"activated" : true
			}
		},
		{
			"id" : "POLICY-dbfd8922-1efe-3b4c-8881-aec1518cc2fc",
			"name" : "Copy of Test partner2",
			"description" : "",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-05T13:25:23+0000",
			"updatedDate" : "2017-05-15T11:08:06+0000",
			"active" : true,
			"enabledMode": "ON",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "msp_5",
				"name" : "Ops Partner",
				"activated" : true
			},
			"allClients" : true
		},
		{
			"id" : "POLICY-5f2d43f2-32cb-3322-a863-19012cfa6c40",
			"name" : "Copy of Test partner3",
			"description" : "",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-05T13:25:32+0000",
			"updatedDate" : "2017-05-05T13:25:32+0000",
			"active" : true,
			"enabledMode": "ON",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "msp_5",
				"name" : "Ops Partner",
				"activated" : true
			},
			"allClients" : true
		},
		{
			"id" : "POLICY-482ebe14-dac7-5d13-24a3-e219fd71d6c7",
			"name" : "Copy of Test partner4",
			"description" : "",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-05T13:25:43+0000",
			"updatedDate" : "2017-05-05T13:25:43+0000",
			"active" : true,
			"enabledMode": "RECOMMEND",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "client_7",
				"name" : "NE  Client",
				"activated" : true
			}
		},
		{
			"id" : "POLICY-8d2b558a-42dd-94aa-edd9-811515bef274",
			"name" : "Copy of Test partner5",
			"description" : "",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-05T13:25:51+0000",
			"updatedDate" : "2017-05-05T13:25:51+0000",
			"active" : true,
			"enabledMode": "OBSERVED",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "client_7",
				"name" : "NE  Client",
				"activated" : true
			}
		},
		{
			"id" : "POLICY-b2d28729-fc38-2cd8-ab57-b60d9366f5fa",
			"name" : "Copy of Test partner6",
			"description" : "",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-05T13:26:14+0000",
			"updatedDate" : "2017-05-05T13:26:14+0000",
			"active" : true,
			"enabledMode": "ON",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "client_6",
				"name" : "Test  Client",
				"activated" : true
			}
		},
		{
			"id" : "POLICY-31c5640e-e9bd-83ee-3fce-46e444855dfe",
			"name" : "Test all clients",
			"description" : "",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-08T07:46:14+0000",
			"updatedDate" : "2017-05-14T11:43:45+0000",
			"active" : true,
			"enabledMode": "ON",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "client_6",
				"name" : "Test  Client",
				"activated" : true
			}
		},
		{
			"id" : "POLICY-8b2c57b5-77e2-47c8-b849-4f9bb71d280d",
			"name" : "Test create API in MSP",
			"description" : "Test description",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-15T08:17:00+0000",
			"updatedDate" : "2017-05-15T08:17:57+0000",
			"active" : true,
			"enabledMode": "ON",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "client_6",
				"name" : "Test  Client",
				"activated" : true
			}
		},
		{
			"id" : "POLICY-d25263af-9cd4-4964-bd8b-f8ede21af086",
			"name" : "Test create API in MSP1",
			"description" : "Test description",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-15T08:27:30+0000",
			"updatedDate" : "2017-05-15T08:28:05+0000",
			"active" : true,
			"enabledMode": "ON",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "client_6",
				"name" : "Test  Client",
				"activated" : true
			}
		},
		{
			"id" : "POLICY-9d6bbe58-2bf6-41cc-9983-fca53b64c9e7",
			"name" : "Test for MSP UI",
			"description" : "",
			"policyType" : "ESCALATION_POLICY",
			"createdDate" : "2017-05-15T12:13:31+0000",
			"updatedDate" : "2017-05-15T12:13:31+0000",
			"active" : true,
			"enabledMode": "ON",
			"mlBased": false,
			"scope" : {
				"uniqueId" : "client_6",
				"name" : "Test  Client",
				"activated" : true
			}
		}
	],
	"totalResults" : 10,
	"pageNo" : 1,
	"pageSize" : 20,
	"totalPages" : 1,
	"nextPage" : false,
	"previousPageNo" : 0,
	"descendingOrder" : false
}