Endpoint
/api/v2/tenants/{tenantId}/changeRequests
Path Parameters
tenantIdstring
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
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
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.
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
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.
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
oldPrioritystring
oldStatusstring
plannedEndstring
plannedStartstring
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
requesterobject
Child Parameters
- requester.email
- requester.firstName
- requester.id
- requester.lastName
- requester.loginName
- requester.phoneNumber
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.
slaDetailsobject
Child Parameters
- slaDetails.resolutionBreach
- slaDetails.resolutionBreachDate
- slaDetails.resolutionTime
- slaDetails.responseBreach
- slaDetails.responseBreachDate
- slaDetails.responseTime
- slaDetails.slaPolicy
sourcestring
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
updatedDatestring
workEndstring
workStartstring
{
"assignedUser": {
"id": "USR0000002146",
"loginName": "FSSL-API-Lab-User-1"
},
"assigneeGroup": {
"name": "API-Lab-Group-1"
},
"attachments": [
{
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
"name": "2.txt"
},
{
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
"name": "1.txt"
}
],
"category": {
"id": 14
},
"cc": "Tester_1@gmail.com,tester@gmail.com",
"changePlan": "VPN Password Change",
"changeType": "Emergency",
"channelId": "2",
"customFields": [
{
"id": "UDF0000003790",
"name": "drop_down_api_lab_3790",
"value": "2"
},
{
"id": "UDF0000003791",
"name": "text_api_lab_3791",
"value": "request custom field - text"
}
],
"description": "I am unable to login into my VPN account, please change and inform",
"extTicketId": "BM023456",
"knowledgeArticleIds": [
15,
24
],
"location": "location@test",
"plannedEnd": "2016-04-30T00:00:00+0000",
"plannedStart": "2016-04-01T00:00:00+0000",
"priority": "Low",
"requester": {
"id": "USR0000002147",
"loginName": "FSSL-API-Lab-User-2"
},
"resources": [
{
"id": "481af404-33a6-4d61-af77-c483ca6641fa"
},
{
"id": "SGP-7adf3762-f310-4c14-9ecd-443eb7c6c208"
},
{
"id": "DGP-8d44a504-fd4b-4a78-ba34-2dfdf3ffb85e"
}
],
"rollbackPlan": "VPN Account",
"subCategory": {
"id": 15
},
"subject": "Request to change my VPN Password",
"tags": "testTag,testTag2",
"testPlan": "VPN @Test",
"workEnd": "2016-04-20T00:00:00+0000",
"workStart": "2016-04-10T00:00:00+0000"
}
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
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
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.
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
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.
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
oldPrioritystring
oldStatusstring
plannedEndstring
plannedStartstring
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
requesterobject
Child Parameters
- requester.email
- requester.firstName
- requester.id
- requester.lastName
- requester.loginName
- requester.phoneNumber
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.
slaDetailsobject
Child Parameters
- slaDetails.resolutionBreach
- slaDetails.resolutionBreachDate
- slaDetails.resolutionTime
- slaDetails.responseBreach
- slaDetails.responseBreachDate
- slaDetails.responseTime
- slaDetails.slaPolicy
sourcestring
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
updatedDatestring
workEndstring
workStartstring
{
"assignedUser": {
"id": "USR0000002146",
"loginName": "FSSL-API-Lab-User-1"
},
"assigneeGroup": {
"name": "API-Lab-Group-1"
},
"attachments": [
{
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
"name": "2.txt"
},
{
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
"name": "1.txt"
}
],
"category": {
"id": 14
},
"cc": "Tester_1@gmail.com,tester@gmail.com",
"changePlan": "VPN Password Change",
"changeType": "Emergency",
"channelId": "2",
"customFields": [
{
"id": "UDF0000003790",
"name": "drop_down_api_lab_3790",
"value": "2"
},
{
"id": "UDF0000003791",
"name": "text_api_lab_3791",
"value": "request custom field - text"
}
],
"description": "I am unable to login into my VPN account, please change and inform",
"extTicketId": "BM023456",
"knowledgeArticleIds": [
15,
24
],
"location": "location@test",
"plannedEnd": "2016-04-30T00:00:00+0000",
"plannedStart": "2016-04-01T00:00:00+0000",
"priority": "Low",
"requester": {
"id": "USR0000002147",
"loginName": "FSSL-API-Lab-User-2"
},
"resources": [
{
"id": "481af404-33a6-4d61-af77-c483ca6641fa"
},
{
"id": "SGP-7adf3762-f310-4c14-9ecd-443eb7c6c208"
},
{
"id": "DGP-8d44a504-fd4b-4a78-ba34-2dfdf3ffb85e"
}
],
"rollbackPlan": "VPN Account",
"subCategory": {
"id": 15
},
"subject": "Request to change my VPN Password",
"tags": "testTag,testTag2",
"testPlan": "VPN @Test",
"workEnd": "2016-04-20T00:00:00+0000",
"workStart": "2016-04-10T00:00:00+0000"
}