Documentation is now available for the Fall 2020 Update release!

Search change requests

This endpoint is used to search for change requests.

Leave Feedback

URL

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

Sample URLs

https://{api-url}/api/v2/tenants/client_1000/changeRequests/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=ticket.id&include=customFields,statusFlow&queryString=status:New,Open+priority: High+requester:USR0000000129+startCreationDate:2016-07-26T14:49:44 0000+endCreationDate:2016-07-28T07:12:19 0000
https://{api-url}/api/v2/tenants/msp_100/changeRequests/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=ticket.id&include=customFields,statusFlow&queryString=status:New,Open+priority: High+requester:USR0000000129+startCreationDate:2016-07-26T14:49:44 0000+endCreationDate:2016-07-28T07:12:19 0000

Parameters

All parameters are optional:

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

NA indicates that the value is not applicable.

Query variables

FieldDefault Value
uniqueIdID of the change request.
Example: CHG0000002401
statusCurrent status of change request.
Supported values: New, Open, Pending, Resolved, Closed, and On Hold.
Example: Closed, Resolved
priorityCurrent priority of change request.
Supported values: Low, Normal, High, Urgent, and Very Low
Example: High, Urgent
subjectA short summary of change request.
Example: Change Request from Alert.
assignedToUser who has been assigned change request.
Example: USR0000000129
requesterUser who requests the change request.
Example: USR0000000129
startCreationDateFilter change request with the creation date. Provide the from date.
Example: 2016-07-26T14:49:44 0000 (GMT)
endCreationDateProvide the to date.
Example: 2016-07-28T07:12:19 0000 (GMT)
startUpdationDateFilter change request with the updation date.
Example: 2016-08-12T06:54:59 0000 (GMT)
endUpdationDateProvide the to date.
Example: 2016-08-15T10:40:20 0000 (GMT)
oldStatusPrevious status of change request.
Supported values: New, Open, Pending, Resolved, and On Hold
Example: Resolved
oldPriorityPrevious priority of change request.
Supported values: Low, Normal, High, Urgent, and Very Low
Example: Urgent
deviceIdUnique ID of the device.
Example: 481af404-33a6-4d61-af77-c483ca6641fa
sourceSource of the change request.
Supported values: PORTAL, INTEGRATION, MOBILE, EMAIL
sourcePolicyTypeSource policy type of the change request.
Supported values: AUTOINCIDENT, INTEGRATION
firstContactFixProblem fixed without assigning to another group.
Example: true, false
assigneeGroupIdsID of the group to which the problem is assigned.
Example: 1, 2, 3
minResponseTimeMinimum response time of request.
Example: 300 (time in seconds)
maxResponseTimeMaximum response time of request.
Example: 600 (time in seconds)
minResolutionTimeMinimum resolution time of request.
Example: 3600 (time in seconds)
maxResolutionTimeMaximum resolution time of request.
Example: 7200 (time in seconds)
minReOpensMinimum number of times change request is reopened.
Example: 5
maxReOpensMaximum number of times change request is reopened.
Example: 8
startClosedDateFilter change requests with the closed date. Provide the from closed date.
Example: 2016-08-12T06:54:59 0000 (GMT)
endClosedDateProvide to closed date.
Example: 2016-08-15T06:54:59 0000 (GMT)
startResolvedDateFilter change requests with the resolved date. Provide from resolved date.
Example: 2016-08-12T06:49:59 0000 (GMT)
endResolvedDateProvide to resolved date.
Example: 2016-08-14T07:49:59 0000 (GMT)
extTicketIdExternal ticket ID.

NA indicates that the value is not applicable.

Sample responses

{
	"results" : [
		{
			"id" : "CHG0000000226",
			"subject" : "Change Request from Alert -  151 ",
			"description" : "Change Request from alert       :  151 ",
			"status" : "Closed",
			"oldStatus" : "Open",
			"priority" : "Very Low",
			"oldPriority" : "Low",
			"requester" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"assignedUser" : {
				"id" : "USR0000000015",
				"loginName" : "brocadeCAdmin@opsramp.com",
				"lastName" : "CAdmin",
				"firstName" : "Brocade",
				"email" : "opsLab@opsramp.com"
			},
			"assigneeGroup" : {
				"id" : 7,
				"name" : "Brocade Lab Users",
				"description" : "All Brocade Lab Users group"
			},
			"resources" : [
				{
					"id" : "481af404-33a6-4d61-af77-c483ca6641fa",
					"name" : "VTHLPT1000",
					"type" : "DEVICE"
				},
				{
					"id" : "SGP-7adf3762-f310-4c14-9ecd-443eb7c6c208",
					"name" : "VTH-SERVICES",
					"type" : "SERVICE"
				},
				{
					"id" : "DGP-8d44a504-fd4b-4a78-ba34-2dfdf3ffb85e",
					"name" : "VTH-ADMIN-DEVS",
					"type" : "DEVICE_GROUP"
				}
			],
			"extTicketId" : "BM023456",
			"cc" : "brocade@opsramp.com, opsLab@opsramp.com",
			"ticketArisedTime" : "",
			"createdUser" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"reason" : "CR Close",
			"alertIds" : [],
			"reOpenCount" : 1,
			"createdDate" : "2016-07-26T14:49:44+0000",
			"client" : {
				"id" : 8,
				"uniqueId" : "client_8",
				"name" : "Brocade Lab",
				"activated" : true
			},
			"updatedDate" : "2016-08-12T06:54:59+0000",
			"priorityUpdatedBy" : {
				"loginName" : "superadmin",
				"lastName" : "Admin",
				"firstName" : "Ops",
				"email" : "escalationmails@opsramp.com"
			},
			"priorityUpdatedDate" : "2016-07-26T14:59:12+0000",
			"statusUpdatedBy" : {
				"loginName" : "superadmin",
				"lastName" : "Admin",
				"firstName" : "Ops",
				"email" : "escalationmails@opsramp.com"
			},
			"statusUpdatedDate" : "2016-08-12T06:54:59+0000",
			"closedDate" : "2016-08-12T06:54:59+0000",
			"slaDetails" : {
				"resolutionTime" : 1370327,
				"responseTime" : 1370285,
				"responseBreach" : false,
				"resolutionBreach" : false,
				"responseBreachDate" : "",
				"resolutionBreachDate" : ""
			},
			"source" : "INTEGRATION",
			"changeType" : "2",
			"changePlan" : "Alert -  151 ",
			"rollbackPlan" : "Introduce new functions",
			"testPlan" : " $alert.device.hostName ",
			"plannedStart" : "2016-08-12T18:53:00+0000",
			"plannedEnd" : "2016-08-29T07:53:59+0000",
			"workStart" : "2016-08-21T18:53:00+0000",
			"workEnd" : "2016-08-27T08:54:59+0000",
			"approvalState" : "APPROVED"
		},
		{
			"id" : "CHG0000000225",
			"subject" : "Change Request from Alert -  151 ",
			"description" : "Change Request from alert       :  151 ",
			"status" : "Resolved",
			"oldStatus" : "Pending",
			"priority" : "Normal",
			"oldPriority" : "Low",
			"requester" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"assignedUser" : {
				"id" : "USR0000000014",
				"loginName" : "opsLab@opsramp.com",
				"lastName" : "Lab",
				"firstName" : "Brocade",
				"email" : "opsLab@opsramp.com"
			},
			"assigneeGroup" : {
				"id" : 7,
				"name" : "Brocade Lab Users",
				"description" : "All Brocade Lab Users group"
			},
			"resources" : [
				{
					"id" : "a17d1896-d18a-4d3e-ae6e-e00465770119",
					"name" : "SVR-DEMO",
					"type" : "DEVICE"
				}
			],
			"extTicketId" : "BM023456",
			"cc" : "brocade@opsramp.com, escalationmails@opsramp.com",
			"ticketArisedTime" : "",
			"createdUser" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"reason" : "CR Resolved",
			"category" : {
				"id" : 6,
				"name" : "Request Level"
			},
			"alertIds" : [],
			"reOpenCount" : 0,
			"createdDate" : "2016-07-26T14:47:43+0000",
			"client" : {
				"id" : 8,
				"uniqueId" : "client_8",
				"name" : "Brocade Lab",
				"activated" : true
			},
			"subCategory" : {
				"id" : 9,
				"name" : "Medium"
			},
			"updatedDate" : "2016-08-12T06:49:59+0000",
			"priorityUpdatedBy" : {
				"loginName" : "superadmin",
				"lastName" : "Admin",
				"firstName" : "Ops",
				"email" : "escalationmails@opsramp.com"
			},
			"priorityUpdatedDate" : "2016-08-12T06:45:31+0000",
			"statusUpdatedBy" : {
				"loginName" : "superadmin",
				"lastName" : "Admin",
				"firstName" : "Ops",
				"email" : "escalationmails@opsramp.com"
			},
			"statusUpdatedDate" : "2016-08-12T06:49:59+0000",
			"resolvedDate" : "2016-08-12T06:49:59+0000",
			"slaDetails" : {
				"resolutionTime" : 1440069,
				"responseTime" : 1439978,
				"responseBreach" : false,
				"resolutionBreach" : false,
				"responseBreachDate" : "",
				"resolutionBreachDate" : ""
			},
			"source" : "INTEGRATION",
			"changeType" : "2",
			"changePlan" : "Alert -  151 ",
			"rollbackPlan" : "functions",
			"testPlan" : " $alert.device.hostName ",
			"plannedStart" : "2016-08-12T18:45:00+0000",
			"plannedEnd" : "2016-08-20T07:45:59+0000",
			"workStart" : "2016-08-15T18:45:00+0000",
			"workEnd" : "2016-08-19T02:51:59+0000",
			"approvalState" : "APPROVED"
		},
		{
			"id" : "CHG0000000224",
			"subject" : "Change Request from Alert -  97 ",
			"description" : "Change Request from alert       :  97 ",
			"status" : "New",
			"oldStatus" : "New",
			"priority" : "Low",
			"oldPriority" : "Low",
			"requester" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"ticketArisedTime" : "",
			"createdUser" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"alertIds" : [],
			"reOpenCount" : 0,
			"createdDate" : "2016-07-26T14:47:22+0000",
			"client" : {
				"id" : 8,
				"uniqueId" : "client_8",
				"name" : "Brocade Lab",
				"activated" : true
			},
			"updatedDate" : "2016-07-26T14:47:23+0000",
			"priorityUpdatedBy" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"priorityUpdatedDate" : "2016-07-26T14:47:22+0000",
			"statusUpdatedBy" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"statusUpdatedDate" : "2016-07-26T14:47:22+0000",
			"slaDetails" : {
				"resolutionTime" : 1440946,
				"responseTime" : 0,
				"responseBreach" : false,
				"resolutionBreach" : false,
				"responseBreachDate" : "",
				"resolutionBreachDate" : ""
			},
			"source" : "INTEGRATION",
			"changeType" : "2",
			"changePlan" : "Alert -  97 ",
			"rollbackPlan" : "functions",
			"testPlan" : " $alert.device.hostName ",
			"plannedStart" : "",
			"plannedEnd" : "",
			"workStart" : "",
			"workEnd" : ""
		},
		{
			"id" : "CHG0000000223",
			"subject" : "Change Request from Alert -  97 ",
			"description" : "Change Request from alert       :  97 ",
			"status" : "New",
			"oldStatus" : "New",
			"priority" : "Low",
			"oldPriority" : "Low",
			"requester" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"ticketArisedTime" : "",
			"createdUser" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"alertIds" : [],
			"reOpenCount" : 0,
			"createdDate" : "2016-07-26T14:45:20+0000",
			"client" : {
				"id" : 8,
				"uniqueId" : "client_8",
				"name" : "Brocade Lab",
				"activated" : true
			},
			"updatedDate" : "2016-07-26T14:45:21+0000",
			"priorityUpdatedBy" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"priorityUpdatedDate" : "2016-07-26T14:45:20+0000",
			"statusUpdatedBy" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"statusUpdatedDate" : "2016-07-26T14:45:20+0000",
			"slaDetails" : {
				"resolutionTime" : 1441068,
				"responseTime" : 0,
				"responseBreach" : false,
				"resolutionBreach" : false,
				"responseBreachDate" : "",
				"resolutionBreachDate" : ""
			},
			"source" : "INTEGRATION",
			"changeType" : "2",
			"changePlan" : "Alert -  97 ",
			"rollbackPlan" : "functions",
			"testPlan" : " $alert.device.hostName ",
			"plannedStart" : "",
			"plannedEnd" : "",
			"workStart" : "",
			"workEnd" : ""
		},
		{
			"id" : "CHG0000000222",
			"subject" : "Change Request from Alert -  150 ",
			"description" : "Change Request from alert      :  150 ",
			"status" : "On Hold",
			"oldStatus" : "Resolved",
			"priority" : "High",
			"oldPriority" : "Normal",
			"requester" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"assignedUser" : {
				"id" : "USR0000000013",
				"loginName" : "brocadePAdmin@opsramp.com",
				"lastName" : "Inc PAdmin",
				"firstName" : "Brocade",
				"email" : "brocadePAdmin@opsramp.com"
			},
			"assigneeGroup" : {
				"id" : 5,
				"name" : "Brocade Inc Users",
				"description" : "Brocade Partner Users"
			},
			"resources" : [
				{
					"id" : "ad0a218d-7512-435c-9b58-614470ee8658",
					"name" : "WORK-PC",
					"type" : "DEVICE"
				},
				{
					"id" : "bc66e17d-09e0-4f8d-bf54-5bcf52bd62ac",
					"name" : "Vit-laptop",
					"type" : "DEVICE"
				}
			],
			"extTicketId" : "BM023456",
			"cc" : "brocade@opsramp.com, brocadePAdmin@opsramp.com",
			"ticketArisedTime" : "",
			"createdUser" : {
				"loginName" : "ops_admin_user",
				"lastName" : " ",
				"firstName" : "Ops Admin",
				"email" : "sample@opsramp.com"
			},
			"reason" : "CR Onhold",
			"alertIds" : [],
			"reOpenCount" : 0,
			"createdDate" : "2016-07-26T14:43:45+0000",
			"suspendEndDate" : "2016-08-23T03:57:00+0000",
			"client" : {
				"id" : 8,
				"uniqueId" : "client_8",
				"name" : "Brocade Lab",
				"activated" : true
			},
			"updatedDate" : "2016-08-12T06:57:58+0000",
			"priorityUpdatedBy" : {
				"loginName" : "superadmin",
				"lastName" : "Admin",
				"firstName" : "Ops",
				"email" : "escalationmails@opsramp.com"
			},
			"priorityUpdatedDate" : "2016-08-12T06:56:51+0000",
			"statusUpdatedBy" : {
				"loginName" : "superadmin",
				"lastName" : "Admin",
				"firstName" : "Ops",
				"email" : "escalationmails@opsramp.com"
			},
			"statusUpdatedDate" : "2016-08-12T06:57:58+0000",
			"resolvedDate" : "2016-08-12T06:57:46+0000",
			"slaDetails" : {
				"resolutionTime" : 1440836,
				"responseTime" : 1440840,
				"responseBreach" : false,
				"resolutionBreach" : false,
				"responseBreachDate" : "",
				"resolutionBreachDate" : ""
			},
			"source" : "INTEGRATION",
			"changeType" : "2",
			"changePlan" : "Alert -  150 ",
			"rollbackPlan" : "functions",
			"testPlan" : " $alert.device.hostName ",
			"plannedStart" : "2016-08-22T18:56:00+0000",
			"plannedEnd" : "2016-08-31T07:56:59+0000",
			"workStart" : "2016-08-24T18:56:00+0000",
			"workEnd" : "2016-08-27T07:30:59+0000",
			"approvalState" : "APPROVED"
		}
	],
	"totalResults" : 96,
	"orderBy" : "ticket.id",
	"pageNo" : 1,
	"pageSize" : 5,
	"totalPages" : 20,
	"nextPage" : true,
	"nextPageNo" : 2,
	"previousPageNo" : 0,
	"descendingOrder" : true
}

If the query parameter consists of parameter include=customFields, statusFlow then each response entity returns the following information.

A sample response with include=customFields:

"customFields": [{
			"id": "UDF0000003808",
			"classCode": "CHANGE",
			"displayLabel": "text field",
			"name": "text_field_3808",
			"fieldType": "TYPE_TEXT",
			"mandatory": false,
			"editable": true,
			"description": "All partners",
			"value": "available",
			"defaultValue": ""
		},
		{
			"id": "UDF0000003810",
			"classCode": "CHANGE",
			"displayLabel": "numeric",
			"name": "numeric_3810",
			"fieldType": "TYPE_NUMBER",
			"mandatory": false,
			"editable": true,
			"description": "Testing numeric",
			"value": "120",
			"defaultValue": ""
		},
		{
			"id": "UDF0000003790",
			"classCode": "CHANGE",
			"displayLabel": "drop-down-api-lab",
			"name": "drop_down_api_lab_3790",
			"fieldType": "TYPE_DROPDOWN",
			"mandatory": false,
			"editable": true,
			"description": "Test case",
			"options": [{
					"label": "first",
					"value": "1"
				},
				{
					"label": "second",
					"value": "2"
				}
			],
			"value": "1",
			"defaultValue": "",
			"selectedOption": {
				"label": "first",
				"value": "1"
			}
		},
		{
			"id": "UDF0000003791",
			"classCode": "CHANGE",
			"displayLabel": "text-api-lab",
			"name": "text_api_lab_3791",
			"fieldType": "TYPE_TEXT",
			"mandatory": false,
			"editable": true,
			"description": "Test case for text field",
			"value": "request custom field - text-updated",
			"defaultValue": "Test Text"
		},
		{
			"id": "UDF0000003792",
			"classCode": "CHANGE",
			"displayLabel": "multi line text-api-lab",
			"name": "multi_line_text_api_lab_3792",
			"fieldType": "TYPE_TEXTAREA",
			"mandatory": false,
			"editable": true,
			"description": "Test case for multi line text",
			"value": "text",
			"defaultValue": "multi \nline \ntext"
		},
		{
			"id": "UDF0000003793",
			"classCode": "CHANGE",
			"displayLabel": "Numeric-api-lab",
			"name": "numeric_api_lab_3793",
			"fieldType": "TYPE_NUMBER",
			"mandatory": false,
			"editable": true,
			"description": "Numeric test case",
			"value": "1",
			"defaultValue": "1"
		},
		{
			"id": "UDF0000003794",
			"classCode": "CHANGE",
			"displayLabel": "checkbox-api-lab",
			"name": "checkbox_api_lab_3794",
			"fieldType": "TYPE_CHECKBOX",
			"mandatory": false,
			"editable": true,
			"description": "Test case for check box",
			"options": [{
				"label": "yes",
				"value": "1"
			}],
			"value": "1",
			"defaultValue": "0",
			"selectedOption": {
				"label": "yes",
				"value": "1"
			}
		},
		{
			"id": "UDF0000003795",
			"classCode": "CHANGE",
			"displayLabel": "Date-ap-lab",
			"name": "date_ap_lab_3795",
			"fieldType": "TYPE_DATE",
			"mandatory": false,
			"editable": true,
			"description": "Test case for date field",
			"value": "2016-02-26T00:00:00+0000",
			"defaultValue": "2016-02-26T00:00:00+0000"
		},
		{
			"id": "UDF0000003796",
			"classCode": "CHANGE",
			"displayLabel": "dateTime-api-lab",
			"name": "datetime_api_lab_3796",
			"fieldType": "TYPE_DATETIME",
			"mandatory": false,
			"editable": true,
			"description": "Test case for Date and time",
			"value": "2016-02-26T12:13:00+0000",
			"defaultValue": "2016-02-26T12:13:00+0000"
		}
]

A sample response with include=statusFlow:

"statusFlow": [{
			"status": "New",
			"timeSpent": 1492634,
			"createdDate": "2016-07-25T12:42:19+0000",
			"updatedBy": {
				"loginName": "john.smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@gmail.com"
			}
		},
		{
			"status": "Resolved",
			"reason": "Resolving as fixed",
			"notes": "resolution summary",
			"timeSpent": 18,
			"createdDate": "2016-07-25T19:19:33+0000",
			"updatedBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "john@gmail.com"
			}
		},
		{
			"status": "Pending",
			"timeSpent": 13,
			"reason": "Waiting for customer inputs",
			"createdDate": "2016-07-27T10:04:31+0000",
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com"
			}
		},
		{
			"status": "On Hold",
			"reason": "Required information is not available, making as on hold",
			"createdDate": "2016-07-28T11:04:44+0000",
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com"
			}
		}
]