Documentation is now available for the Fall 2020 Update release!

Update time bound request

This endpoint is used to update a time bound request.

Leave Feedback

URL

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

Sample URLs

https://{api-url}/api/v2/tenants/client_7/timeBoundRequests/TBT0000001127

Parameters

FieldSub-FieldsData TypeValuesDescription
requesterNAStringNARequester of the time bound request.
statusNAStringNAStatus of time bound request. Prerequisites to update the status of a time bound request are:
  1. Check status flow transitions of the time request using the get time bound request. The status available for the request is provided in the field allowedStatus.
    Example: "name": "Open"
  2. Check if the status change reasons are enabled:
    • "reasonsEnabled": "true" indicates, reason is mandatory while changing the status.
    • "reasonsEnabled": "false" indicates reason is optional.
suspendEndDateNAStringDate on which the time bound request is put on hold.
assignedUserNAStringNAUser responsible for working on the time bound request.
resourcesNAStringNAResources for which the request is applicable.
priorityNAStringLow, Normal, High, Urgent, and Very LowRequest priority.
consolestypeStringMANAGEMENTCONSOLE, ADMINCONSOLEConsole type
consoleProtocolStringRDP, SSH, TELNET, VNCConsole protocol.
optionsStringDISKSHARE, CLIPBOARDACCESS, FILETRANSFERConsole options.
schedule1. startTimeStringNASchedule start time.
2. endTimeStringNASchedule end time.
3. typeStringone-time, recurringSchedule type.
4. timezoneStringNASchedule time zone. The list of timezones are shown below.
Example: "timezone": "America/Los_Angeles"
5. patternStringNARecurrence pattern.
    1. typeString daily, weekly, monthlyRecurrence pattern type.
    2. dayFrequencyStringeveryday, every weekdayDay on which the time bound request should occur.
    3. weekDaysStringSUN, MON, TUE, WED, THU, FRI, SATWeekdays on which the time bound request should occur.
    4. dayOfMonthInteger1,2,3,4........31Day of the month on which time bound request should occur.
    5. weekIndexStringFIRST, SECOND, THIRD, FOURTH, LASTWeekdays on which the time bound request should occur every month.
    6. dayOfWeekStringSUN, MON, TUE, WED, THU, FRI, SATWeekdays on which the time bound request should occur every month.
participantUsersNAStringNA
ccNAStringNACc email.
customFieldsNAStringNAUser defined fields to include additional information of the time bound request. Refer to get custom fields to retrieve the list of custom fields defined for time bound requests.
responseNAStringNARelevant information of the ticket can be included in response.
Example: file attachments, external ID, tags
knowledgeArticleIdsNAIntegerNAAttach knowledge base articles to a time bound request. Below are the instructions to retrieve the knowledge base article ID:
  1. Log into OpsRamp.
  2. Click Knowledge Base.
  3. Select the required article and then copy the article ID.
  4. Provide the article ID in "knowledgeArticleIds" field.
    Example: "knowledgeArticleIds": 23, 65

NA indicates that the value is not applicable.

Schedule Pattern Types

Define the time duration for the time bound request to occur once or repeatedly.

Define the time bound request to occur for one-time only:

{
	"type": "one-time",
	"startTime": "2016-04-10T12:15:00+0000",
	"endTime": "2016-04-10T12:15:00+0000",
	"timezone": "America/Los_Angeles"
}

Define the time bound request to occur repeatedly:

{
	"type": "recurring",
	"startTime": "2016-04-10T12:15:00+0000",
	"endTime": "2016-04-10T12:15:00+0000",
	"timezone": "America/Los_Angeles",
	"pattern": {
		"type": "daily",
		"dayFrequency": "everyday"
	}
}

Below are the recurrence schedule pattern types:

  1. Daily
"pattern": {
		"type": "daily",
		"dayFrequency": "everyday"
	}
  1. Weekly
"pattern": {
		"type": "weekly",
		"weekDays": "Monday"
}
  1. Monthly
"pattern": {
		"type": "monthly",
		"dayOfMonth": "1",
		"weekIndex": "First",
		"dayOfWeek": "Monday"
}

Status code

200 OK

Sample request

{
	"priority": "High",
	"status": "Open",
	"reason": "Sample Reason",
	"notes": "Notes for Time bound request",
	"cc": "support.admin@myorganization.com, network.admin@myorganization.com",
	"requester": {
		"id": "USR0000002146",
		"loginName": "John.Smith"
	},
	"assignedUser": {
		"id": "USR0000002146",
		"loginName": "John.Smith"
	},
	"participantUsers": [{
			"id": "USR0000002146",
			"loginName": "John.Smith"
		},
		{
			"id": "USR0000002147",
			"loginName": "James.Hudson"
		}
	],
	"resources": [{
		"id": "481af404-33a6-4d61-af77-c483ca6641fa"
	}, {
		"id": "SGP-7adf3762-f310-4c14-9ecd-443eb7c6c208"
	}, {
		"id": "DGP-8d44a504-fd4b-4a78-ba34-2dfdf3ffb85e"
	}],
	"consoles": [{
			"type": "MANAGEMENTCONSOLE",
			"consoleProtocol": "RDP",
			"options": "DISKSHARE,FILETRANSFER"
		},
		{
			"type": "MANAGEMENTCONSOLE",
			"consoleProtocol": "SSH",
			"options": "CLIPBOARDACCESS"
		},
		{
			"type": "MANAGEMENTCONSOLE",
			"consoleProtocol": "TELNET",
			"options": "DISKSHARE,CLIPBOARDACCESS"
		},
		{
			"type": "MANAGEMENTCONSOLE",
			"consoleProtocol": "VNC"
		},
		{
			"type": "ADMINCONSOLE"
		}
	],
	"schedule": {
		"type": "recurring",
		"startTime": "2016-04-10T12:15:00+0000",
		"endTime": "2016-04-20T12:15:00+0000",
		"timezone": "America/Los_Angeles",
		"pattern": {
			"type": "daily",
			"dayFrequency": "everyday"
		}
	},
	"customFields": [{
			"id": "UDF0000003804",
			"name": "drop_down_3804",
			"value": "1"
		},
		{
			"id": "UDF0000003806",
			"name": "multi_line_text_3806",
			"value": "time bound request"
		}
	],
	"response": {
		"description": "Adding Attachments to TBR",
		"internal": "false",
		"creator": {
			"id": "USR0000002146",
			"loginName": "John.Smith"
		},
		"tags": "API, TBR",
		"attachments": [{
				"name": "2.txt",
				"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
			},
			{
				"name": "1.txt",
				"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
			}
		]
	},
	"knowledgeArticleIds": [
		25, 16
	]
}

Sample response

{
	"id": "TBT0000001127",
	"subject": "Take backup of email servers",
	"description": "Need to provide email availability even if one mail servers goes down.",
	"status": "Open",
	"oldStatus": "New",
	"priority": "High",
	"oldPriority": "Low",
	"requester": {
		"id": "USR0000002146",
		"loginName": "John.Smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@myorganization.com"
	},
	"assignedUser": {
		"id": "USR0000002146",
		"loginName": "John.Smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@myorganization.com"
	},
	"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"
		}
	],
	"customFields": [{
			"id": "UDF0000003805",
			"classCode": "ACSTICKET",
			"displayLabel": "Numeric",
			"name": "numeric_3805",
			"fieldType": "TYPE_NUMBER",
			"mandatory": false,
			"editable": true,
			"description": "Testing numeric"
		},
		{
			"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"
		},
		{
			"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",
			"selectedOption": {
				"label": "One",
				"value": "1"
			}
		}
	],
	"cc": "support.admin@myorganization.com, network.admin@myorganization.com",
	"ticketArisedTime": "",
	"createdUser": {
		"id": "USR0000002095",
		"loginName": "ops_admin_user",
		"lastName": " ",
		"firstName": "Ops Admin",
		"email": "opsLab@opsramp.com"
	},
	"reason": "Global Open Reason",
	"alertIds": [],
	"createdDate": "2016-03-30T12:20:00+0000",
	"consoles": [{
			"consoleProtocol": "RDP",
			"type": "MANAGEMENTCONSOLE",
			"options": "DISKSHARE,FILETRANSFER"
		},
		{
			"consoleProtocol": "SSH",
			"type": "MANAGEMENTCONSOLE",
			"options": "CLIPBOARDACCESS"
		},
		{
			"consoleProtocol": "TELNET",
			"type": "MANAGEMENTCONSOLE",
			"options": "DISKSHARE,CLIPBOARDACCESS"
		},
		{
			"consoleProtocol": "VNC",
			"type": "MANAGEMENTCONSOLE"
		},
		{
			"consoleProtocol": "RDP",
			"type": "ADMINCONSOLE"
		}
	],
	"participantUsers": [{
			"id": "USR0000002146",
			"loginName": "John.Smith"
		},
		{
			"id": "USR0000002147",
			"loginName": "James.Hudson"
		}
	],
	"allowedStatus": [{
			"id": "3",
			"name": "Pending",
			"reasonsEnabled": true,
			"reasonsDefined": false
		},
		{
			"id": "4",
			"name": "Resolved",
			"reasonsEnabled": true,
			"reasonsDefined": false
		},
		{
			"id": "5",
			"name": "Closed",
			"reasonsEnabled": true,
			"reasonsDefined": false
		},
		{
			"id": "6",
			"name": "On Hold",
			"reasonsEnabled": true,
			"reasonsDefined": false
		}
	],
	"client": {
		"id": 7,
		"uniqueId": "client_7",
		"name": "API Lab",
		"activated": true,
		"updatedTime": "",
		"createdTime": "2012-10-09T11:49:34+0000"
	},
	"updatedDate": "2016-03-30T12:22:52+0000",
	"priorityUpdatedBy": {
		"id": "USR0000002095",
		"loginName": "ops_admin_user",
		"lastName": " ",
		"firstName": "Ops Admin",
		"email": "opsLab@opsramp.com"
	},
	"priorityUpdatedDate": "2016-03-30T12:22:51+0000",
	"statusUpdatedBy": {
		"id": "USR0000002095",
		"loginName": "ops_admin_user",
		"lastName": " ",
		"firstName": "Ops Admin",
		"email": "opsLab@opsramp.com"
	},
	"statusUpdatedDate": "2016-03-30T12:22:51+0000",
	"slaDetails": {
		"resolutionTime": 0,
		"responseTime": 171,
		"responseBreach": false,
		"resolutionBreach": false,
		"responseBreachDate": "",
		"resolutionBreachDate": ""
	},
	"source": "INTEGRATION",
	"schedule": {
		"type": "recurring",
		"startTime": "2016-04-10T05:15:00+0000",
		"endTime": "2016-04-20T05:15:00+0000",
		"pattern": {
			"dayOfWeek": "everyday"
		}
	},
	"statusFlow": [{
			"status": "New",
			"timeSpent": 1492634,
			"createdDate": "2016-07-25T12:42:19+0000",
			"updatedBy": {
				"loginName": "ops_admin_user",
				"lastName": " ",
				"firstName": "Ops Admin",
				"email": "sample@opsramp.com"
			}
		},
		{
			"status": "Open",
			"reason": "Started Working",
			"createdDate": "2016-08-11T19:19:51+0000",
			"updatedBy": {
				"loginName": "john.smith",
				"lastName": "smith",
				"firstName": "john",
				"email": "sample@opsramp.com",
				"phoneNumber": "9985597783"
			}
		}
	],
	"knowledgeArticleIds": [
		26, 12
	],
	"attachedArticles": [{
			"id": 25,
			"subject": "Configure backup email server"
		},
		{
			"id": 16,
			"subject": "Primary mail server"
		}
	]
}