Search SLA policies

URL

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

Sample URLs

To retrieve a list of incident-related service level agreements:

https://{api-url}/api/v2/tenants/client_8/incidents/slaPolicies/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=active:true

https://{api-url}/api/v2/tenants/msp_7/incidents/slaPolicies/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=active:true

To retrieve a list of service request-related service level agreements:

https://{api-url}/api/v2/tenants/client_8/serviceRequests/slaPolicies/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=active:true

https://{api-url}/api/v2/tenants/client_8/serviceRequests/slaPolicies/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=active:true

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

Query variables

Query Variable	Values	Description
queryString={queryString}	true, false	Status of the SLA policy. If active=true retrieves all the active SLA policiesIf active=false retrieves all the inactive SLA policies.

Notes

SLA policies are valid only for incident and service request. Sample responses for response time, resolution breach time, resolution remainders, and response remainders use seconds format. 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.
Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).

Sample response

{
	"results": [{
			"id": 7,
			"name": "P0_SR_SLA",
			"requestType": "SERVICEREQUEST",
			"withinBussinessHours": true,
			"active": true,
			"priority": "Low",
			"createdDate": "2016-08-12T11:42:14+0000",
			"updatedDate": "2016-11-21T11:13:56+0000",
			"responseBreachTime": 36000,
			"resolutionBreachTime": 36000,
			"createdBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@gmail.com",
				"phoneNumber": "9985512345"
			},
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com",
				"phoneNumber": ""
			}
		},
		{
			"id": 6,
			"name": "P4_INCIDENT_SLA",
			"requestType": "INCIDENT",
			"withinBussinessHours": true,
			"active": true,
			"priority": "Low",
			"createdDate": "2016-07-24T13:59:54+0000",
			"updatedDate": "2016-11-22T09:42:18+0000",
			"responseBreachTime": 18000,
			"resolutionBreachTime": 72000,
			"createdBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@gmail.com",
				"phoneNumber": "9985512340"
			},
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com",
				"phoneNumber": ""
			}
		},
		{
			"id": 4,
			"name": "P2_INCIDENT_SLA",
			"requestType": "INCIDENT",
			"withinBussinessHours": true,
			"active": true,
			"priority": "Normal",
			"createdDate": "2016-07-24T13:19:53+0000",
			"updatedDate": "2016-07-24T07:49:53+0000",
			"responseBreachTime": 1800,
			"resolutionBreachTime": 5400,
			"createdBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@gmail.com",
				"phoneNumber": "9985512356"
			},
			"updatedBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@gmail.com",
				"phoneNumber": "9985512356"
			}
		},
		{
			"id": 3,
			"name": "P1_INCIDENT_SLA",
			"requestType": "INCIDENT",
			"withinBussinessHours": true,
			"active": true,
			"priority": "High",
			"createdDate": "2016-07-24T13:18:31+0000",
			"updatedDate": "2016-07-24T07:48:31+0000",
			"responseBreachTime": 1800,
			"resolutionBreachTime": 3600,
			"createdBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@gmail.com",
				"phoneNumber": "9985512340"
			},
			"updatedBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@gmail.com",
				"phoneNumber": "9985512340"
			}
		},
		{
			"id": 2,
			"name": "P0_INCIDENT_SLA",
			"requestType": "INCIDENT",
			"withinBussinessHours": true,
			"active": true,
			"priority": "Urgent",
			"createdDate": "2016-07-24T13:16:50+0000",
			"updatedDate": "2016-07-24T07:46:50+0000",
			"responseBreachTime": 1800,
			"resolutionBreachTime": 18000,
			"createdBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@gmail.com",
				"phoneNumber": "9985597783"
			},
			"updatedBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@gmail.com",
				"phoneNumber": "9985597783"
			}
		}
	],
	"totalResults": 5,
	"orderBy": "id",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": true
}