Endpoint
/api/v2/tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}
Gets the details of a time bound request.
Path Parameters
tenantIdstring
timeBoundRequestIdstring
Responses
OK
alertIdsarray
allowedStatusarray
Child Parameters
- allowedStatus.id
- allowedStatus.name
- allowedStatus.reasonsDefined
- allowedStatus.reasonsEnabled
assignedUserobject
Child Parameters
- assignedUser.email
- assignedUser.firstName
- assignedUser.id
- assignedUser.lastName
- assignedUser.loginName
- assignedUser.phoneNumber
assigneeGroupobject
Child Parameters
- assigneeGroup.description
- assigneeGroup.id
- assigneeGroup.name
- assigneeGroup.userCount
attachedRequestsarray
Attach service requests to an incident. Use the search service requests to get list of service requests in a client.
Child Parameters
- attachedRequests.id
attachmentsarray
Attach files related to the change request. Convert attachment files to byte stream with base64-encoding. The file size limit of an attachment is 50 MB.
Child Parameters
- attachments.file
- attachments.name
businessImpactobject
Child Parameters
- businessImpact.createdBy
- businessImpact.createdDate
- businessImpact.description
- (Optional) Short summary describing the business impact.
- businessImpact.name
- Business impact name.
- businessImpact.uniqueId
- businessImpact.updatedBy
- businessImpact.updatedDate
categoryobject
Add the change request under a category. Use the get API to get the list of categories.
Child Parameters
- category.id
ccstring
Cc email.
changePlanstring
Description of the change plan.
changeRequestobject
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
Child Parameters
- changeRequest.id
changeTypestring
Normal or Emergency depending on the Priority of a change request. For example, create a change type Emergency for change requests that must be processed immediately or if Priority of a request is High.
channelIdstring
clientobject
Child Parameters
- client.activated
- client.createdTime
- client.id
- client.name
- client.uniqueId
- client.updatedTime
closedSummarystring
consolesarray
Child Parameters
- consoles.consoleProtocol
- Console protocol.
- consoles.options
- Console options.
- consoles.type
- Console type
createdDatestring
createdUserobject
Child Parameters
- createdUser.email
- createdUser.firstName
- createdUser.id
- createdUser.lastName
- createdUser.loginName
- createdUser.phoneNumber
customFieldsarray
Child Parameters
- customFields.classCode
- customFields.customField
- customFields.defaultValue
- customFields.description
- customFields.displayLabel
- customFields.editable
- customFields.fieldType
- customFields.id
- customFields.mandatory
- customFields.name
- customFields.options
- customFields.selectedOption
- customFields.value
descriptionstring
Ticket description.
dueDatestring
extTicketIdstring
Attach third party ticket ID.
idstring
knowledgeArticleIdsarray
Attach knowledge base articles related to the change request for further reference. To get a 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": 25, 16.
Child Parameters
locationstring
notesstring
oldPrioritystring
oldStatusstring
parentIdstring
Attach incident. Provide the incident ID as an attachment.
plannedEndstring
plannedStartstring
policyobject
Child Parameters
- policy.active
- policy.createdDate
- policy.executionOrder
- policy.id
- policy.name
- policy.policyType
- policy.updatedDate
prioritystring
Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.
priorityUpdatedByobject
Child Parameters
- priorityUpdatedBy.email
- priorityUpdatedBy.firstName
- priorityUpdatedBy.id
- priorityUpdatedBy.lastName
- priorityUpdatedBy.loginName
- priorityUpdatedBy.phoneNumber
priorityUpdatedDatestring
problemobject
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
Child Parameters
- problem.id
reOpenCountinteger
requesterobject
Child Parameters
- requester.email
- requester.firstName
- requester.id
- requester.lastName
- requester.loginName
- requester.phoneNumber
resolutionSummarystring
resolveDatestring
resourcesarray
Child Parameters
- resources.aliasName
- resources.hostName
- resources.id
- resources.metaData
- resources.name
- resources.resourceName
- resources.resourceType
- resources.type
rollbackPlanstring
Description of roll back plan.
scheduleobject
Child Parameters
- schedule.endTime
- Schedule end time.
- schedule.pattern
- Recurrence pattern.
- schedule.startTime
- Schedule start time.
- schedule.timezone
- Schedule time zone. The list of timezones are shown below. Example: "timezone": "America/Los_Angeles"
- schedule.type
- Schedule type.
serviceRestoreDatestring
slaDetailsobject
Child Parameters
- slaDetails.resolutionBreach
- slaDetails.resolutionBreachDate
- slaDetails.resolutionTime
- slaDetails.responseBreach
- slaDetails.responseBreachDate
- slaDetails.responseTime
- slaDetails.slaPolicy
sourcestring
sourceEntityTypestring
sourceEntityTypeIdstring
sourcePolicyTypestring
sourcePolicyTypeIdstring
statusstring
statusFlowarray
Child Parameters
- statusFlow.createdDate
- statusFlow.notes
- statusFlow.reason
- statusFlow.status
- statusFlow.timeSpent
- statusFlow.updatedBy
statusUpdatedByobject
Child Parameters
- statusUpdatedBy.email
- statusUpdatedBy.firstName
- statusUpdatedBy.id
- statusUpdatedBy.lastName
- statusUpdatedBy.loginName
- statusUpdatedBy.phoneNumber
statusUpdatedDatestring
subCategoryobject
Add the change request under a sub-category. Use get categories to get the list of sub-categories.
Child Parameters
- subCategory.id
subjectstring
Ticket subject.
tagsstring
testPlanstring
Description of test plan.
ticketArisedTimestring
toEmailstring
Email address of the user. An email notification is sent to the user.
updatedDatestring
workEndstring
workStartstring
{
"alertIds": [],
"allowedStatus": [
{
"id": "1",
"name": "New",
"reasonsDefined": false,
"reasonsEnabled": false
},
{
"id": "2",
"name": "Open",
"reasonsDefined": true,
"reasonsEnabled": true
},
{
"id": "3",
"name": "Pending",
"reasonsDefined": true,
"reasonsEnabled": true
},
{
"id": "4",
"name": "Resolved",
"reasonsDefined": true,
"reasonsEnabled": true
},
{
"id": "5",
"name": "Closed",
"reasonsDefined": true,
"reasonsEnabled": true
}
],
"assignedUser": {
"email": "admin.userA@domain.com",
"firstName": "admin",
"id": "USR0000000011",
"lastName": "user",
"loginName": "admin.user"
},
"assigneeGroup": {
"description": "Brocade Partner Users",
"id": 5,
"name": "Brocade Inc Users"
},
"attachedArticles": [
{
"id": 22,
"subject": "Temporary Internet Files"
},
{
"id": 13,
"subject": "Setup Log Files"
}
],
"cc": "support.admin@myorganization.com, teamA@myorganization.com",
"client": {
"activated": true,
"id": 8,
"name": "Brocade Lab",
"uniqueId": "client_8"
},
"consoles": [
{
"consoleProtocol": "SSH",
"options": "CLIPBOARDACCESS",
"type": "MANAGEMENTCONSOLE"
},
{
"consoleProtocol": "RDP",
"type": "ADMINCONSOLE"
}
],
"createdDate": "2016-08-12T08:30:18+0000",
"createdUser": {
"email": "escalationmails@gmail.com",
"firstName": "OpsRamp",
"lastName": "Admin",
"loginName": "superadmin"
},
"customFields": [
{
"classCode": "ACSTICKET",
"defaultValue": "",
"description": "all partners",
"displayLabel": "text field",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000003808",
"mandatory": false,
"name": "text_field_3808",
"value": "available"
},
{
"classCode": "ACSTICKET",
"defaultValue": "",
"description": "testing numeric",
"displayLabel": "numeric",
"editable": true,
"fieldType": "TYPE_NUMBER",
"id": "UDF0000003810",
"mandatory": false,
"name": "numeric_3810",
"value": "120"
},
{
"classCode": "ACSTICKET",
"defaultValue": "",
"description": "Test case",
"displayLabel": "drop-down-api-lab",
"editable": true,
"fieldType": "TYPE_DROPDOWN",
"id": "UDF0000003790",
"mandatory": false,
"name": "drop_down_api_lab_3790",
"options": [
{
"label": "first",
"value": "1"
},
{
"label": "second",
"value": "2"
}
],
"selectedOption": {
"label": "first",
"value": "1"
},
"value": "1"
},
{
"classCode": "ACSTICKET",
"defaultValue": "Test Text",
"description": "test case for text field",
"displayLabel": "text-api-lab",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000003791",
"mandatory": false,
"name": "text_api_lab_3791",
"value": "request custom field - text-updated"
},
{
"classCode": "ACSTICKET",
"defaultValue": "multi \nline \ntext",
"description": "test case for multi line text",
"displayLabel": "multi line text-api-lab",
"editable": true,
"fieldType": "TYPE_TEXTAREA",
"id": "UDF0000003792",
"mandatory": false,
"name": "multi_line_text_api_lab_3792",
"value": "text"
},
{
"classCode": "ACSTICKET",
"defaultValue": "1",
"description": "numeric test case",
"displayLabel": "Numeric-api-lab",
"editable": true,
"fieldType": "TYPE_NUMBER",
"id": "UDF0000003793",
"mandatory": false,
"name": "numeric_api_lab_3793",
"value": "1"
},
{
"classCode": "ACSTICKET",
"defaultValue": "0",
"description": "test case for check box",
"displayLabel": "checkbox-api-lab",
"editable": true,
"fieldType": "TYPE_CHECKBOX",
"id": "UDF0000003794",
"mandatory": false,
"name": "checkbox_api_lab_3794",
"options": [
{
"label": "yes",
"value": "1"
}
],
"selectedOption": {
"label": "yes",
"value": "1"
},
"value": "1"
},
{
"classCode": "ACSTICKET",
"defaultValue": "2016-02-26T00:00:00+0000",
"description": "test case for date field",
"displayLabel": "Date-ap-lab",
"editable": true,
"fieldType": "TYPE_DATE",
"id": "UDF0000003795",
"mandatory": false,
"name": "date_ap_lab_3795",
"value": "2016-02-26T00:00:00+0000"
},
{
"classCode": "ACSTICKET",
"defaultValue": "2016-02-26T12:13:00+0000",
"description": "test case for Date and time",
"displayLabel": "dateTime-api-lab",
"editable": true,
"fieldType": "TYPE_DATETIME",
"id": "UDF0000003796",
"mandatory": false,
"name": "datetime_api_lab_3796",
"value": "2016-02-26T12:13:00+0000"
}
],
"description": "Required to detect, validate and truncate the unwanted data.",
"id": "TBT0000010422",
"knowledgeArticleIds": [
22,
13
],
"oldPriority": "Low",
"oldStatus": "On-Hold",
"participantUsers": [
{
"id": "USR0000000011",
"loginName": "brocade.Inc"
},
{
"id": "USR0000000013",
"loginName": "brocade.PAdmin@gmail.com"
}
],
"priority": "High",
"priorityUpdatedBy": {
"email": "escalationmails@gmail.com",
"firstName": "OpsRamp",
"lastName": "Admin",
"loginName": "superadmin"
},
"priorityUpdatedDate": "2016-08-12T08:30:41+0000",
"reOpenCount": 0,
"reason": "On hold TBR",
"requester": {
"email": "john.r@domain.com",
"firstName": "John",
"lastName": "rivers",
"loginName": "john.rivers"
},
"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"
}
],
"schedule": {
"endTime": "2016-08-30T19:00:00+0000",
"startTime": "2016-08-14T18:00:00+0000",
"type": "one-time"
},
"slaDetails": {
"resolutionBreach": false,
"resolutionBreachDate": "",
"resolutionTime": 23,
"responseBreach": false,
"responseBreachDate": "",
"responseTime": 0
},
"source": "PORTAL",
"status": "Resolved",
"statusFlow": [
{
"createdDate": "2016-07-25T12:42:19+0000",
"status": "New",
"timeSpent": 1492634,
"updatedBy": {
"email": "sample@gmail.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
}
},
{
"createdDate": "2016-08-11T19:19:33+0000",
"notes": "resolution summary",
"reason": "Resolving as fixed",
"status": "Resolved",
"timeSpent": 18,
"updatedBy": {
"email": "sample@gmail.com",
"firstName": "john",
"lastName": "smith",
"loginName": "john.smith"
}
},
{
"createdDate": "2016-11-22T10:04:31+0000",
"reason": "Waiting for customer inputs",
"status": "Pending",
"timeSpent": 13,
"updatedBy": {
"email": "sample@gmail.com",
"firstName": "SP",
"id": "USR0000000018",
"lastName": "Admin",
"loginName": "superadmin"
}
},
{
"createdDate": "2016-11-22T10:04:44+0000",
"reason": "On hold TBR",
"status": "On Hold",
"updatedBy": {
"email": "sample@gmail.com",
"firstName": "SP",
"id": "USR0000000018",
"lastName": "Admin",
"loginName": "superadmin"
}
}
],
"statusUpdatedBy": {
"email": "escalationmails@gmail.com",
"firstName": "OpsRamp",
"lastName": "Admin",
"loginName": "superadmin"
},
"statusUpdatedDate": "2016-08-12T08:30:53+0000",
"subject": "Junk data should be truncated from repository",
"ticketArisedTime": "",
"updatedDate": "2016-08-12T08:30:53+0000"
}
Endpoint
/api/v2/tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}
Updates a time bound request.
Sample URLs
https://{api-url}/api/v2/tenants/client_7/timeBoundRequests/TBT0000001127
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:
- Daily
"pattern": {
"type": "daily",
"dayFrequency": "everyday"
}
- Weekly
"pattern": {
"type": "weekly",
"weekDays": "Monday"
}
- Monthly
"pattern": {
"type": "monthly",
"dayOfMonth": "1",
"weekIndex": "First",
"dayOfWeek": "Monday"
}
Path Parameters
tenantIdstring
timeBoundRequestIdstring
alertIdsarray
allowedStatusarray
Child Parameters
- allowedStatus.id
- allowedStatus.name
- allowedStatus.reasonsDefined
- allowedStatus.reasonsEnabled
assignedUserobject
Child Parameters
- assignedUser.email
- assignedUser.firstName
- assignedUser.id
- assignedUser.lastName
- assignedUser.loginName
- assignedUser.phoneNumber
assigneeGroupobject
Child Parameters
- assigneeGroup.description
- assigneeGroup.id
- assigneeGroup.name
- assigneeGroup.userCount
attachedRequestsarray
Attach service requests to an incident. Use the search service requests to get list of service requests in a client.
Child Parameters
- attachedRequests.id
attachmentsarray
Attach files related to the change request. Convert attachment files to byte stream with base64-encoding. The file size limit of an attachment is 50 MB.
Child Parameters
- attachments.file
- attachments.name
businessImpactobject
Child Parameters
- businessImpact.createdBy
- businessImpact.createdDate
- businessImpact.description
- (Optional) Short summary describing the business impact.
- businessImpact.name
- Business impact name.
- businessImpact.uniqueId
- businessImpact.updatedBy
- businessImpact.updatedDate
categoryobject
Add the change request under a category. Use the get API to get the list of categories.
Child Parameters
- category.id
ccstring
Cc email.
changePlanstring
Description of the change plan.
changeRequestobject
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
Child Parameters
- changeRequest.id
changeTypestring
Normal or Emergency depending on the Priority of a change request. For example, create a change type Emergency for change requests that must be processed immediately or if Priority of a request is High.
channelIdstring
clientobject
Child Parameters
- client.activated
- client.createdTime
- client.id
- client.name
- client.uniqueId
- client.updatedTime
closedSummarystring
consolesarray
Child Parameters
- consoles.consoleProtocol
- Console protocol.
- consoles.options
- Console options.
- consoles.type
- Console type
createdDatestring
createdUserobject
Child Parameters
- createdUser.email
- createdUser.firstName
- createdUser.id
- createdUser.lastName
- createdUser.loginName
- createdUser.phoneNumber
customFieldsarray
Child Parameters
- customFields.classCode
- customFields.customField
- customFields.defaultValue
- customFields.description
- customFields.displayLabel
- customFields.editable
- customFields.fieldType
- customFields.id
- customFields.mandatory
- customFields.name
- customFields.options
- customFields.selectedOption
- customFields.value
descriptionstring
Ticket description.
dueDatestring
extTicketIdstring
Attach third party ticket ID.
idstring
knowledgeArticleIdsarray
Attach knowledge base articles related to the change request for further reference. To get a 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": 25, 16.
Child Parameters
locationstring
notesstring
oldPrioritystring
oldStatusstring
parentIdstring
Attach incident. Provide the incident ID as an attachment.
plannedEndstring
plannedStartstring
policyobject
Child Parameters
- policy.active
- policy.createdDate
- policy.executionOrder
- policy.id
- policy.name
- policy.policyType
- policy.updatedDate
prioritystring
Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.
priorityUpdatedByobject
Child Parameters
- priorityUpdatedBy.email
- priorityUpdatedBy.firstName
- priorityUpdatedBy.id
- priorityUpdatedBy.lastName
- priorityUpdatedBy.loginName
- priorityUpdatedBy.phoneNumber
priorityUpdatedDatestring
problemobject
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
Child Parameters
- problem.id
reOpenCountinteger
requesterobject
Child Parameters
- requester.email
- requester.firstName
- requester.id
- requester.lastName
- requester.loginName
- requester.phoneNumber
resolutionSummarystring
resolveDatestring
resourcesarray
Child Parameters
- resources.aliasName
- resources.hostName
- resources.id
- resources.metaData
- resources.name
- resources.resourceName
- resources.resourceType
- resources.type
rollbackPlanstring
Description of roll back plan.
scheduleobject
Child Parameters
- schedule.endTime
- Schedule end time.
- schedule.pattern
- Recurrence pattern.
- schedule.startTime
- Schedule start time.
- schedule.timezone
- Schedule time zone. The list of timezones are shown below. Example: "timezone": "America/Los_Angeles"
- schedule.type
- Schedule type.
serviceRestoreDatestring
slaDetailsobject
Child Parameters
- slaDetails.resolutionBreach
- slaDetails.resolutionBreachDate
- slaDetails.resolutionTime
- slaDetails.responseBreach
- slaDetails.responseBreachDate
- slaDetails.responseTime
- slaDetails.slaPolicy
sourcestring
sourceEntityTypestring
sourceEntityTypeIdstring
sourcePolicyTypestring
sourcePolicyTypeIdstring
statusstring
statusFlowarray
Child Parameters
- statusFlow.createdDate
- statusFlow.notes
- statusFlow.reason
- statusFlow.status
- statusFlow.timeSpent
- statusFlow.updatedBy
statusUpdatedByobject
Child Parameters
- statusUpdatedBy.email
- statusUpdatedBy.firstName
- statusUpdatedBy.id
- statusUpdatedBy.lastName
- statusUpdatedBy.loginName
- statusUpdatedBy.phoneNumber
statusUpdatedDatestring
subCategoryobject
Add the change request under a sub-category. Use get categories to get the list of sub-categories.
Child Parameters
- subCategory.id
subjectstring
Ticket subject.
tagsstring
testPlanstring
Description of test plan.
ticketArisedTimestring
toEmailstring
Email address of the user. An email notification is sent to the user.
updatedDatestring
workEndstring
workStartstring
{
"assignedUser": {
"id": "USR0000002146",
"loginName": "John.Smith"
},
"cc": "support.admin@myorganization.com, network.admin@myorganization.com",
"consoles": [
{
"consoleProtocol": "RDP",
"options": "DISKSHARE,FILETRANSFER",
"type": "MANAGEMENTCONSOLE"
},
{
"consoleProtocol": "SSH",
"options": "CLIPBOARDACCESS",
"type": "MANAGEMENTCONSOLE"
},
{
"consoleProtocol": "TELNET",
"options": "DISKSHARE,CLIPBOARDACCESS",
"type": "MANAGEMENTCONSOLE"
},
{
"consoleProtocol": "VNC",
"type": "MANAGEMENTCONSOLE"
},
{
"type": "ADMINCONSOLE"
}
],
"customFields": [
{
"id": "UDF0000003804",
"name": "drop_down_3804",
"value": "1"
},
{
"id": "UDF0000003806",
"name": "multi_line_text_3806",
"value": "time bound request"
}
],
"knowledgeArticleIds": [
25,
16
],
"notes": "Notes for Time bound request",
"participantUsers": [
{
"id": "USR0000002146",
"loginName": "John.Smith"
},
{
"id": "USR0000002147",
"loginName": "James.Hudson"
}
],
"priority": "High",
"reason": "Sample Reason",
"requester": {
"id": "USR0000002146",
"loginName": "John.Smith"
},
"resources": [
{
"id": "481af404-33a6-4d61-af77-c483ca6641fa"
},
{
"id": "SGP-7adf3762-f310-4c14-9ecd-443eb7c6c208"
},
{
"id": "DGP-8d44a504-fd4b-4a78-ba34-2dfdf3ffb85e"
}
],
"response": {
"attachments": [
{
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
"name": "2.txt"
},
{
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
"name": "1.txt"
}
],
"creator": {
"id": "USR0000002146",
"loginName": "John.Smith"
},
"description": "Adding Attachments to TBR",
"internal": "false",
"tags": "API, TBR"
},
"schedule": {
"endTime": "2016-04-20T12:15:00+0000",
"pattern": {
"dayFrequency": "everyday",
"type": "daily"
},
"startTime": "2016-04-10T12:15:00+0000",
"timezone": "America/Los_Angeles",
"type": "recurring"
},
"status": "Open"
}
Responses
OK
alertIdsarray
allowedStatusarray
Child Parameters
- allowedStatus.id
- allowedStatus.name
- allowedStatus.reasonsDefined
- allowedStatus.reasonsEnabled
assignedUserobject
Child Parameters
- assignedUser.email
- assignedUser.firstName
- assignedUser.id
- assignedUser.lastName
- assignedUser.loginName
- assignedUser.phoneNumber
assigneeGroupobject
Child Parameters
- assigneeGroup.description
- assigneeGroup.id
- assigneeGroup.name
- assigneeGroup.userCount
attachedRequestsarray
Attach service requests to an incident. Use the search service requests to get list of service requests in a client.
Child Parameters
- attachedRequests.id
attachmentsarray
Attach files related to the change request. Convert attachment files to byte stream with base64-encoding. The file size limit of an attachment is 50 MB.
Child Parameters
- attachments.file
- attachments.name
businessImpactobject
Child Parameters
- businessImpact.createdBy
- businessImpact.createdDate
- businessImpact.description
- (Optional) Short summary describing the business impact.
- businessImpact.name
- Business impact name.
- businessImpact.uniqueId
- businessImpact.updatedBy
- businessImpact.updatedDate
categoryobject
Add the change request under a category. Use the get API to get the list of categories.
Child Parameters
- category.id
ccstring
Cc email.
changePlanstring
Description of the change plan.
changeRequestobject
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
Child Parameters
- changeRequest.id
changeTypestring
Normal or Emergency depending on the Priority of a change request. For example, create a change type Emergency for change requests that must be processed immediately or if Priority of a request is High.
channelIdstring
clientobject
Child Parameters
- client.activated
- client.createdTime
- client.id
- client.name
- client.uniqueId
- client.updatedTime
closedSummarystring
consolesarray
Child Parameters
- consoles.consoleProtocol
- Console protocol.
- consoles.options
- Console options.
- consoles.type
- Console type
createdDatestring
createdUserobject
Child Parameters
- createdUser.email
- createdUser.firstName
- createdUser.id
- createdUser.lastName
- createdUser.loginName
- createdUser.phoneNumber
customFieldsarray
Child Parameters
- customFields.classCode
- customFields.customField
- customFields.defaultValue
- customFields.description
- customFields.displayLabel
- customFields.editable
- customFields.fieldType
- customFields.id
- customFields.mandatory
- customFields.name
- customFields.options
- customFields.selectedOption
- customFields.value
descriptionstring
Ticket description.
dueDatestring
extTicketIdstring
Attach third party ticket ID.
idstring
knowledgeArticleIdsarray
Attach knowledge base articles related to the change request for further reference. To get a 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": 25, 16.
Child Parameters
locationstring
notesstring
oldPrioritystring
oldStatusstring
parentIdstring
Attach incident. Provide the incident ID as an attachment.
plannedEndstring
plannedStartstring
policyobject
Child Parameters
- policy.active
- policy.createdDate
- policy.executionOrder
- policy.id
- policy.name
- policy.policyType
- policy.updatedDate
prioritystring
Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.
priorityUpdatedByobject
Child Parameters
- priorityUpdatedBy.email
- priorityUpdatedBy.firstName
- priorityUpdatedBy.id
- priorityUpdatedBy.lastName
- priorityUpdatedBy.loginName
- priorityUpdatedBy.phoneNumber
priorityUpdatedDatestring
problemobject
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
Child Parameters
- problem.id
reOpenCountinteger
requesterobject
Child Parameters
- requester.email
- requester.firstName
- requester.id
- requester.lastName
- requester.loginName
- requester.phoneNumber
resolutionSummarystring
resolveDatestring
resourcesarray
Child Parameters
- resources.aliasName
- resources.hostName
- resources.id
- resources.metaData
- resources.name
- resources.resourceName
- resources.resourceType
- resources.type
rollbackPlanstring
Description of roll back plan.
scheduleobject
Child Parameters
- schedule.endTime
- Schedule end time.
- schedule.pattern
- Recurrence pattern.
- schedule.startTime
- Schedule start time.
- schedule.timezone
- Schedule time zone. The list of timezones are shown below. Example: "timezone": "America/Los_Angeles"
- schedule.type
- Schedule type.
serviceRestoreDatestring
slaDetailsobject
Child Parameters
- slaDetails.resolutionBreach
- slaDetails.resolutionBreachDate
- slaDetails.resolutionTime
- slaDetails.responseBreach
- slaDetails.responseBreachDate
- slaDetails.responseTime
- slaDetails.slaPolicy
sourcestring
sourceEntityTypestring
sourceEntityTypeIdstring
sourcePolicyTypestring
sourcePolicyTypeIdstring
statusstring
statusFlowarray
Child Parameters
- statusFlow.createdDate
- statusFlow.notes
- statusFlow.reason
- statusFlow.status
- statusFlow.timeSpent
- statusFlow.updatedBy
statusUpdatedByobject
Child Parameters
- statusUpdatedBy.email
- statusUpdatedBy.firstName
- statusUpdatedBy.id
- statusUpdatedBy.lastName
- statusUpdatedBy.loginName
- statusUpdatedBy.phoneNumber
statusUpdatedDatestring
subCategoryobject
Add the change request under a sub-category. Use get categories to get the list of sub-categories.
Child Parameters
- subCategory.id
subjectstring
Ticket subject.
tagsstring
testPlanstring
Description of test plan.
ticketArisedTimestring
toEmailstring
Email address of the user. An email notification is sent to the user.
updatedDatestring
workEndstring
workStartstring
{
"alertIds": [],
"allowedStatus": [
{
"id": "3",
"name": "Pending",
"reasonsDefined": false,
"reasonsEnabled": true
},
{
"id": "4",
"name": "Resolved",
"reasonsDefined": false,
"reasonsEnabled": true
},
{
"id": "5",
"name": "Closed",
"reasonsDefined": false,
"reasonsEnabled": true
},
{
"id": "6",
"name": "On Hold",
"reasonsDefined": false,
"reasonsEnabled": true
}
],
"assignedUser": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"id": "USR0000002146",
"lastName": "Smith",
"loginName": "John.Smith"
},
"attachedArticles": [
{
"id": 25,
"subject": "Configure backup email server"
},
{
"id": 16,
"subject": "Primary mail server"
}
],
"cc": "support.admin@myorganization.com, network.admin@myorganization.com",
"client": {
"activated": true,
"createdTime": "2012-10-09T11:49:34+0000",
"id": 7,
"name": "API Lab",
"uniqueId": "client_7",
"updatedTime": ""
},
"consoles": [
{
"consoleProtocol": "RDP",
"options": "DISKSHARE,FILETRANSFER",
"type": "MANAGEMENTCONSOLE"
},
{
"consoleProtocol": "SSH",
"options": "CLIPBOARDACCESS",
"type": "MANAGEMENTCONSOLE"
},
{
"consoleProtocol": "TELNET",
"options": "DISKSHARE,CLIPBOARDACCESS",
"type": "MANAGEMENTCONSOLE"
},
{
"consoleProtocol": "VNC",
"type": "MANAGEMENTCONSOLE"
},
{
"consoleProtocol": "RDP",
"type": "ADMINCONSOLE"
}
],
"createdDate": "2016-03-30T12:20:00+0000",
"createdUser": {
"email": "opsLab@opsramp.com",
"firstName": "Ops Admin",
"id": "USR0000002095",
"lastName": " ",
"loginName": "ops_admin_user"
},
"customFields": [
{
"classCode": "ACSTICKET",
"description": "Testing numeric",
"displayLabel": "Numeric",
"editable": true,
"fieldType": "TYPE_NUMBER",
"id": "UDF0000003805",
"mandatory": false,
"name": "numeric_3805"
},
{
"classCode": "ACSTICKET",
"description": "multi line text example",
"displayLabel": "Multi line text",
"editable": true,
"fieldType": "TYPE_TEXTAREA",
"id": "UDF0000003806",
"mandatory": false,
"name": "multi_line_text_3806",
"value": "time bound request"
},
{
"classCode": "ACSTICKET",
"description": "Drop down testing",
"displayLabel": "Drop-Down",
"editable": true,
"fieldType": "TYPE_DROPDOWN",
"id": "UDF0000003804",
"mandatory": false,
"name": "drop_down_3804",
"options": [
{
"label": "One",
"value": "1"
},
{
"label": "Two",
"value": "2"
}
],
"selectedOption": {
"label": "One",
"value": "1"
},
"value": "1"
}
],
"description": "Need to provide email availability even if one mail servers goes down.",
"id": "TBT0000001127",
"knowledgeArticleIds": [
26,
12
],
"oldPriority": "Low",
"oldStatus": "New",
"participantUsers": [
{
"id": "USR0000002146",
"loginName": "John.Smith"
},
{
"id": "USR0000002147",
"loginName": "James.Hudson"
}
],
"priority": "High",
"priorityUpdatedBy": {
"email": "opsLab@opsramp.com",
"firstName": "Ops Admin",
"id": "USR0000002095",
"lastName": " ",
"loginName": "ops_admin_user"
},
"priorityUpdatedDate": "2016-03-30T12:22:51+0000",
"reason": "Global Open Reason",
"requester": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"id": "USR0000002146",
"lastName": "Smith",
"loginName": "John.Smith"
},
"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"
}
],
"schedule": {
"endTime": "2016-04-20T05:15:00+0000",
"pattern": {
"dayOfWeek": "MON"
},
"startTime": "2016-04-10T05:15:00+0000",
"type": "recurring"
},
"slaDetails": {
"resolutionBreach": false,
"resolutionBreachDate": "",
"resolutionTime": 0,
"responseBreach": false,
"responseBreachDate": "",
"responseTime": 171
},
"source": "INTEGRATION",
"status": "Open",
"statusFlow": [
{
"createdDate": "2016-07-25T12:42:19+0000",
"status": "New",
"timeSpent": 1492634,
"updatedBy": {
"email": "sample@opsramp.com",
"firstName": "Ops Admin",
"lastName": " ",
"loginName": "ops_admin_user"
}
},
{
"createdDate": "2016-08-11T19:19:51+0000",
"reason": "Started Working",
"status": "Open",
"updatedBy": {
"email": "sample@opsramp.com",
"firstName": "john",
"lastName": "smith",
"loginName": "john.smith",
"phoneNumber": "9985597783"
}
}
],
"statusUpdatedBy": {
"email": "opsLab@opsramp.com",
"firstName": "Ops Admin",
"id": "USR0000002095",
"lastName": " ",
"loginName": "ops_admin_user"
},
"statusUpdatedDate": "2016-03-30T12:22:51+0000",
"subject": "Take backup of email servers",
"ticketArisedTime": "",
"updatedDate": "2016-03-30T12:22:52+0000"
}