Endpoint
/api/v2/tenants/{tenantId}/changeRequests
Path Parameters
tenantId
string

Describes the clientId of the tenant

alertIds
array

allowedStatus
array

allowedStatus.id
allowedStatus.name
allowedStatus.reasonsDefined
allowedStatus.reasonsEnabled
assignedUser
object

assignedUser.email
assignedUser.firstName
assignedUser.id
assignedUser.lastName
assignedUser.loginName
assignedUser.phoneNumber
assigneeGroup
object

assigneeGroup.description
assigneeGroup.id
assigneeGroup.name
assigneeGroup.userCount
attachedArticles
array

attachedArticles.id
attachedArticles.subject
attachments
array

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.

attachments.file
attachments.name
category
object

Add the change request under a category. Use the get API to get the list of categories.

category.id
category.uniqueId
Category uuid
cc
string

Cc email.

changePlan
string

Description of the change plan.

changeType
string

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.

channelId
string

client
object

client.activated
client.createdTime
client.id
client.name
client.uniqueId
client.updatedTime
createdDate
string

createdUser
object

createdUser.email
createdUser.firstName
createdUser.id
createdUser.lastName
createdUser.loginName
createdUser.phoneNumber
customFields
array

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
description
string

Ticket description.

extTicketId
string

Attach third party ticket ID.

id
string

knowledgeArticleIds
array

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.

location
string

oldPriority
string

oldStatus
string

plannedEnd
string

plannedStart
string

priority
string

Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.

priorityUpdatedBy
object

priorityUpdatedBy.email
priorityUpdatedBy.firstName
priorityUpdatedBy.id
priorityUpdatedBy.lastName
priorityUpdatedBy.loginName
priorityUpdatedBy.phoneNumber
priorityUpdatedDate
string

requester
object

requester.email
requester.firstName
requester.id
requester.lastName
requester.loginName
requester.phoneNumber
resources
array

resources.aliasName
resources.hostName
resources.id
resources.metaData
resources.name
resources.resourceName
resources.resourceType
resources.type
rollbackPlan
string

Description of roll back plan.

slaDetails
object

slaDetails.resolutionBreach
slaDetails.resolutionBreachDate
slaDetails.resolutionTime
slaDetails.responseBreach
slaDetails.responseBreachDate
slaDetails.responseTime
slaDetails.slaPolicy
source
string

statusFlow
array

statusFlow.createdDate
statusFlow.notes
statusFlow.reason
statusFlow.status
statusFlow.timeSpent
statusFlow.updatedBy
statusUpdatedBy
object

statusUpdatedBy.email
statusUpdatedBy.firstName
statusUpdatedBy.id
statusUpdatedBy.lastName
statusUpdatedBy.loginName
statusUpdatedBy.phoneNumber
statusUpdatedDate
string

subCategory
object

Add the change request under a sub-category. Use get categories to get the list of sub-categories.

subCategory.id
subCategory.uniqueId
subject
string

Ticket subject.

tags
string

testPlan
string

Description of test plan.

ticketArisedTime
string

updatedDate
string

workEnd
string

workStart
string

{
  "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": 40066,
    "uniqueId": "SCAT-b18d6c9c-72ee-4e6f-9009-632ea0fe3a8b"
  },
  "cc": "escalate@opsramp.com,tester@opsramp.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": [
    "KB0000000025",
    "KB0000000016"
  ],
  "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": 40068,
    "uniqueId": "SCAT-2aff08e6-ef11-4e5e-b11c-856550bf55e4"
  },
  "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

alertIds
array

allowedStatus
array

allowedStatus.id
allowedStatus.name
allowedStatus.reasonsDefined
allowedStatus.reasonsEnabled
assignedUser
object

assignedUser.email
assignedUser.firstName
assignedUser.id
assignedUser.lastName
assignedUser.loginName
assignedUser.phoneNumber
assigneeGroup
object

assigneeGroup.description
assigneeGroup.id
assigneeGroup.name
assigneeGroup.userCount
attachedArticles
array

attachedArticles.id
attachedArticles.subject
attachments
array

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.

attachments.file
attachments.name
category
object

Add the change request under a category. Use the get API to get the list of categories.

category.id
category.uniqueId
Category uuid
cc
string

Cc email.

changePlan
string

Description of the change plan.

changeType
string

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.

channelId
string

client
object

client.activated
client.createdTime
client.id
client.name
client.uniqueId
client.updatedTime
createdDate
string

createdUser
object

createdUser.email
createdUser.firstName
createdUser.id
createdUser.lastName
createdUser.loginName
createdUser.phoneNumber
customFields
array

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
description
string

Ticket description.

extTicketId
string

Attach third party ticket ID.

id
string

knowledgeArticleIds
array

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.

location
string

oldPriority
string

oldStatus
string

plannedEnd
string

plannedStart
string

priority
string

Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.

priorityUpdatedBy
object

priorityUpdatedBy.email
priorityUpdatedBy.firstName
priorityUpdatedBy.id
priorityUpdatedBy.lastName
priorityUpdatedBy.loginName
priorityUpdatedBy.phoneNumber
priorityUpdatedDate
string

requester
object

requester.email
requester.firstName
requester.id
requester.lastName
requester.loginName
requester.phoneNumber
resources
array

resources.aliasName
resources.hostName
resources.id
resources.metaData
resources.name
resources.resourceName
resources.resourceType
resources.type
rollbackPlan
string

Description of roll back plan.

slaDetails
object

slaDetails.resolutionBreach
slaDetails.resolutionBreachDate
slaDetails.resolutionTime
slaDetails.responseBreach
slaDetails.responseBreachDate
slaDetails.responseTime
slaDetails.slaPolicy
source
string

statusFlow
array

statusFlow.createdDate
statusFlow.notes
statusFlow.reason
statusFlow.status
statusFlow.timeSpent
statusFlow.updatedBy
statusUpdatedBy
object

statusUpdatedBy.email
statusUpdatedBy.firstName
statusUpdatedBy.id
statusUpdatedBy.lastName
statusUpdatedBy.loginName
statusUpdatedBy.phoneNumber
statusUpdatedDate
string

subCategory
object

Add the change request under a sub-category. Use get categories to get the list of sub-categories.

subCategory.id
subCategory.uniqueId
subject
string

Ticket subject.

tags
string

testPlan
string

Description of test plan.

ticketArisedTime
string

updatedDate
string

workEnd
string

workStart
string

{
  "alertIds": [],
  "allowedStatus": [
    {
      "id": "2",
      "name": "Open",
      "reasonsDefined": true,
      "reasonsEnabled": true
    },
    {
      "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": true,
      "reasonsEnabled": true
    }
  ],
  "assignedUser": {
    "email": "tester@opsramp.com",
    "firstName": "FSSL",
    "id": "USR0000002146",
    "lastName": "API-Lab",
    "loginName": "FSSL-API-Lab-User-1"
  },
  "assigneeGroup": {
    "id": 17,
    "name": "API-Lab-Group-1",
    "userCount": 2
  },
  "attachedArticles": [
    {
      "id": "KB0000000016",
      "subject": "sample article"
    },
    {
      "id": "KB0000000025",
      "subject": "test article SLA"
    }
  ],
  "category": {
    "id": 40066,
    "name": "Sample Category",
    "uniqueId": "SCAT-b18d6c9c-72ee-4e6f-9009-632ea0fe3a8b"
  },
  "cc": "escalate@opsramp.com,tester@opsramp.com",
  "changePlan": "VPN Password Change",
  "changeType": "Emergency",
  "client": {
    "activated": true,
    "createdTime": "2012-10-09T11:49:34+0000",
    "id": 7,
    "name": "API Lab",
    "uniqueId": "client_7",
    "updatedTime": ""
  },
  "createdDate": "2016-03-29T09:08:40+0000",
  "createdUser": {
    "email": "opsLab@opsramp.com",
    "firstName": "Ops Admin",
    "id": "USR0000002095",
    "lastName": " ",
    "loginName": "ops_admin_user"
  },
  "customFields": [
    {
      "classCode": "CHANGE",
      "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": "second",
        "value": "2"
      },
      "value": "2"
    },
    {
      "classCode": "CHANGE",
      "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"
    },
    {
      "classCode": "CHANGE",
      "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"
    },
    {
      "classCode": "CHANGE",
      "description": "numeric test case",
      "displayLabel": "Numeric-api-lab",
      "editable": true,
      "fieldType": "TYPE_NUMBER",
      "id": "UDF0000003793",
      "mandatory": false,
      "name": "numeric_api_lab_3793"
    },
    {
      "classCode": "CHANGE",
      "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"
        }
      ]
    },
    {
      "classCode": "CHANGE",
      "description": "test case for date field",
      "displayLabel": "Date-ap-lab",
      "editable": true,
      "fieldType": "TYPE_DATE",
      "id": "UDF0000003795",
      "mandatory": false,
      "name": "date_ap_lab_3795"
    },
    {
      "classCode": "CHANGE",
      "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"
    }
  ],
  "description": "I am unable to login into my VPN account, please change and inform",
  "extTicketId": "BM023456",
  "id": "CHG0000001111",
  "knowledgeArticleIds": [
    "KB0000000025",
    "KB0000000016"
  ],
  "oldPriority": "Low",
  "oldStatus": "New",
  "plannedEnd": "2016-04-30T00:00:00+0000",
  "plannedStart": "2016-04-01T00:00:00+0000",
  "priority": "Low",
  "priorityUpdatedBy": {
    "email": "tester3@opsramp.com",
    "firstName": "FSSL",
    "id": "USR0000002147",
    "lastName": "API-Lab-2",
    "loginName": "FSSL-API-Lab-User-2"
  },
  "priorityUpdatedDate": "2016-03-29T09:08:40+0000",
  "requester": {
    "email": "tester3@opsramp.com",
    "firstName": "FSSL",
    "id": "USR0000002147",
    "lastName": "API-Lab-2",
    "loginName": "FSSL-API-Lab-User-2",
    "phoneNumber": "9876543219"
  },
  "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"
    }
  ],
  "rollbackPlan": "VPN Account",
  "slaDetails": {
    "resolutionBreach": false,
    "resolutionBreachDate": "",
    "resolutionTime": 0,
    "responseBreach": false,
    "responseBreachDate": "",
    "responseTime": 0
  },
  "source": "INTEGRATION",
  "status": "New",
  "statusFlow": [
    {
      "createdDate": "2016-07-25T12:42:19+0000",
      "status": "New",
      "updatedBy": {
        "email": "sample@opsramp.com",
        "firstName": "Ops Admin",
        "lastName": " ",
        "loginName": "ops_admin_user"
      }
    }
  ],
  "statusUpdatedBy": {
    "email": "tester3@opsramp.com",
    "firstName": "FSSL",
    "id": "USR0000002147",
    "lastName": "API-Lab-2",
    "loginName": "FSSL-API-Lab-User-2"
  },
  "statusUpdatedDate": "2016-03-29T09:08:40+0000",
  "subCategory": {
    "id": 40068,
    "name": "Sample Sub Category",
    "uniqueId": "SCAT-2aff08e6-ef11-4e5e-b11c-856550bf55e4"
  },
  "subject": "Request to change my VPN Password",
  "testPlan": "VPN @Test",
  "ticketArisedTime": "",
  "updatedDate": "2016-03-29T09:08:41+0000",
  "workEnd": "2016-04-20T00:00:00+0000",
  "workStart": "2016-04-10T00:00:00+0000"
}