Close time bound request

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}/close

Sample URLs

https://{api-url}/api/v2/tenants/client_8/timeBoundRequests/TBT0000000379/close

Parameters

Field	Data Type	Description
reason	String	Reason for closing the time bound request. This is mandatory only if the option Enable reasons to change status Close is enabled for time bound request in service desk settings (example steps below).
notes	String	Additional information to add to a time bound request.

Follow the steps before closing a time bound request:

Step 1: To enable the option to provide reason for closing a time bound request.

Log into OpsRamp.
Click Setup.
On the left-hand side panel, click Service Desk.
In Configuration, click Settings.
Select client and then click Customize.
In the Time Bound Request section, select option Enable reasons to change status Close and then click Save.

Step 2: Check the status flow transition for Closed.

Click Setup.
On the left-hand panel, click Service Desk.
In Configuration, click Status Flows.
Check the status flow for the entity Time Bound and check the transition of the status Closed.
If Closed is unavailable, this indicates the time bound request cannot be closed.

Step 3: Provide the reason for changing the status.

Click Setup.
On the left-hand side panel, click Service Desk.
In Configuration, click Status Change Reasons.
Click Add, select the scope, client, request type, entity status as Closed and provide the reason and then click Submit.

Notes

Use the get time bound request to check if status Closed and reasons to provide for Close are enabled. If under the field allowedStatus if name: Closed and reasonsEnabled: true, this indicates reasons should be provided for closing a time bound request.
Use the get status change reasons to provide the reasons to Close. The reasons configured in status: Closed are accepted, but a new provided reason would result in an error.

Status code

200 OK

Sample request

{
	"reason": "Network Serveres up and running",
	"notes": "Network Servers issue solved in site CA."
}

Sample response

{
	"id": "TBT0000000379",
	"subject": "Network servers not accessible",
	"description": "Network servers down in site CA",
	"status": "Closed",
	"oldStatus": "Open",
	"priority": "Low",
	"oldPriority": "High",
	"notes": "Network Serveres up and running",
	"closedSummary": "Network Servers issue solved in site CA",
	"requester": {
		"loginName": "john.smith",
		"lastName": "smith",
		"firstName": "john",
		"email": "john.smith@gmail.com",
		"phoneNumber": "998-559-1234"
	},
	"assignedUser": {
		"id": "USR0000000013",
		"loginName": "brocadePAdmin",
		"lastName": "PAdmin",
		"firstName": "Brocade",
		"email": "brocade.PAdmin@gmail.com",
		"phoneNumber": "809-625-1234"
	},
	"assigneeGroup": {
		"id": 5,
		"name": "Brocade Inc Users",
		"description": "Brocade Partner Users"
	},
	"resources": [{
			"id": "d628b4f1-37ad-49de-8487-43125ec3178a",
			"name": "SJLPT204",
			"type": "DEVICE"
		},
		{
			"id": "DGP-420a80f4-5fba-46d5-a1c1-20e2df4a326a",
			"name": "OPSRAMP-SJ",
			"type": "DEVICE_GROUP"
		},
		{
			"id": "SGP-c2af3866-fc89-47dd-b83f-bcc8df0b2a0a",
			"name": "VTH Services",
			"type": "SERVICE"
		}
	],
	"customFields": [{
			"id": "UDF0000003805",
			"classCode": "ACSTICKET",
			"displayLabel": "Numeric",
			"name": "numeric_3805",
			"fieldType": "TYPE_NUMBER",
			"mandatory": false,
			"editable": true,
			"description": "Testing numeric",
			"defaultValue": "10"
		},
		{
			"id": "UDF0000003806",
			"classCode": "ACSTICKET",
			"displayLabel": "Multi line text",
			"name": "multi_line_text_3806",
			"fieldType": "TYPE_TEXTAREA",
			"mandatory": false,
			"editable": true,
			"description": "multi line text example",
			"value": "time bound request-update",
			"defaultValue": "Time bound request"
		},
		{
			"id": "UDF0000003807",
			"classCode": "ACSTICKET",
			"displayLabel": "Text field",
			"name": "text_field_3807",
			"fieldType": "TYPE_TEXT",
			"mandatory": false,
			"editable": true,
			"description": "Text field mandatory",
			"value": "Text-Update",
			"defaultValue": "Mandatory"
		},
		{
			"id": "UDF0000003804",
			"classCode": "ACSTICKET",
			"displayLabel": "Drop-Down",
			"name": "drop_down_3804",
			"fieldType": "TYPE_DROPDOWN",
			"mandatory": false,
			"editable": true,
			"description": "Drop down testing",
			"options": [{
					"label": "One",
					"value": "1"
				},
				{
					"label": "Two",
					"value": "2"
				}
			],
			"value": "1",
			"defaultValue": "",
			"selectedOption": {
				"label": "One",
				"value": "1"
			}
		},
		{
			"id": "UDF0000003821",
			"classCode": "ACSTICKET",
			"displayLabel": "Date",
			"name": "date_3821",
			"fieldType": "TYPE_DATE",
			"mandatory": false,
			"editable": true,
			"description": "",
			"defaultValue": "2016-02-26T12:13:00+0000"
		},
		{
			"id": "UDF0000003822",
			"classCode": "ACSTICKET",
			"displayLabel": "Date and Time",
			"name": "date_and_time_3822",
			"fieldType": "TYPE_DATETIME",
			"mandatory": false,
			"editable": true,
			"description": "",
			"defaultValue": "2016-02-26T12:13:00+0000"
		}
	],
	"cc": "sample@gmail.com",
	"ticketArisedTime": "",
	"createdUser": {
		"id": "USR0000000018",
		"loginName": "superadmin",
		"lastName": "Admin",
		"firstName": "SP",
		"email": "sample@gmail.com"
	},
	"reason": "Close TBR",
	"alertIds": [],
	"reOpenCount": 0,
	"createdDate": "2016-11-25T10:30:56+0000",
	"allowedStatus": [],
	"client": {
		"id": 8,
		"uniqueId": "client_8",
		"name": "Brocade Lab",
		"activated": true
	},
	"sourcePolicyType": "MANUAL",
	"updatedDate": "2016-11-25T10:33:15+0000",
	"priorityUpdatedBy": {
		"id": "USR0000000018",
		"loginName": "superadmin",
		"lastName": "Admin",
		"firstName": "SP",
		"email": "sample@gmail.com"
	},
	"priorityUpdatedDate": "2016-11-25T10:31:44+0000",
	"statusUpdatedBy": {
		"loginName": "john.bolt",
		"lastName": "Bolt",
		"firstName": "John",
		"email": "john.bolt@gmail.com"
	},
	"statusUpdatedDate": "2016-11-25T10:33:15+0000",
	"closedDate": "2016-11-25T10:33:15+0000",
	"slaDetails": {
		"resolutionTime": 117,
		"responseTime": 48,
		"responseBreach": false,
		"resolutionBreach": false,
		"responseBreachDate": "",
		"resolutionBreachDate": ""
	},
	"source": "PORTAL",
	"statusFlow": [{
			"status": "New",
			"timeSpent": 48,
			"createdDate": "2016-11-25T10:30:56+0000",
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com"
			}
		},
		{
			"status": "Open",
			"timeSpent": 18,
			"reason": "Open TBR",
			"createdDate": "2016-11-25T10:31:44+0000",
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com"
			}
		},
		{
			"status": "Pending",
			"timeSpent": 14,
			"reason": "Pending TBR",
			"createdDate": "2016-11-25T10:32:02+0000",
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com"
			}
		},
		{
			"status": "On Hold",
			"timeSpent": 8,
			"reason": "On hold TBR",
			"createdDate": "2016-11-25T10:32:16+0000",
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com"
			}
		},
		{
			"status": "Open",
			"timeSpent": 51,
			"reason": "Open TBR",
			"createdDate": "2016-11-25T10:32:24+0000",
			"updatedBy": {
				"id": "USR0000000018",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "SP",
				"email": "sample@gmail.com"
			}
		},
		{
			"status": "Closed",
			"reason": "Network Serveres up and running",
			"notes": "Network Servers issue solved in site CA.",
			"createdDate": "2016-11-25T10:33:15+0000",
			"updatedBy": {
				"loginName": "john.bolt",
				"lastName": "Bolt",
				"firstName": "John",
				"email": "john.bolt@gmail.com"
			}
		}
	]
}