PATCH Update Change
URL: {{server-url}}/api/v1/change/{{change-Id}}
You can update the details of an existing change request ticket by calling the above endpoint with the change ID. You have to pass the following key-values:
Header
Key | Description |
---|---|
Authorization | Bearer {access token obtained after authorization} |
Content-Type | application/json |
Body
Key | Value Type | Description |
---|---|---|
priorityName | String | Shows the importance of the Change. Possible values are: Low, Medium, High, or Urgent. |
urgencyName | String | Marks the Change as urgent. Possible values are: Low, Medium, High, or Urgent. |
impactName | String | Describes the effect of the Change. Possible values are: Low, On User , On department, Or On Business. |
riskType | String | Marks the type of risk involved in the Change. The possible values are: Low, Medium, or High. |
categoryName | String | Category Name of a Change. |
locationName | String | Name of the Location where the Change happened. Note that Location Must Exist with the same name. |
tags | String Array | These are additional identifiers attached to a ticket. It is a list that can contain n number of STRINGS. |
departmentName | String | Additional information about the ticket. |
changeType | String | Marks the type of change. The possible values are: Minor, Standard, Significant, Major, or Emergency. |
targetEnvironment | String | Describes the target environment in which the change will be created. The possible values are: Production, Development, or Test. |
subject* | String | Subject of the change. |
description | String | Description about the change. |
startDate* | long | Set the start date and time when the change was initiated. |
endDate* | long | Set the end date to resolve/close the change. |
fileAttachments | Object Array | Reference File Name of attachments for a Change. For example:[ { “refFileName” : “abc”, “realName” : “xyz.pdf” } ] |
Example (Request & Response)
Request
curl --location --request PATCH 'https://172.16.12.135/api/v1/change/5' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9zc29faWQiOjAsInVzZXJfbmFtZSI6ImpvaG5AbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTY4NjEzNzQ4NywibG9naW5fbXNwX3BvcnRhbF9pZCI6MCwianRpIjoiOGExMDc1MTEtY2YzMC00ODcxLWIzZmQtZjY1NmJhNDUyZTRiIiwiY2xpZW50X2lkIjoiUG9zdG1hbkludGVncmF0aW9uLWNsaWVudCIsInRlbmFudElkZW50aWZpZXIiOiJhcG9sbyJ9.RJg1Xb7rVs6s-H6qItcZmwkLAaV95AgbaY813PTn4U7fDz7GV0gpVsMgWAcHOnSV9J-KGsdyw2vHf4rIfH3h8dt3SrJq8B7TPpMNoccXCarBEIGxxMHAKxs9cPcuw7cNY2K5NtfKj8voRl0vRzBHxuQS8h7J6hYnLcOFIMK6B-hZQKBbYL7lgOY86l22ghjcyY9pzwaxjNgtD922f3ru998Vyh_shJOiIb12QEqYxXzle-hxrOkB4hF_KVoNXi0w3WhO09i_aOX16eAfYo2neXd-hZ2TyFqQsKGNy83ZDkwCeeV2Y6Yxck_tMTBVrH6YaAc4NDtEHpA591vImBWtwg' \
--header 'Content-type: application/json' \
--data '{
"priorityName": "Medium",
"urgencyName": "Low",
"impactName": "Low",
"riskType":"Medium",
"categoryName": "Network",
"locationName": "USA",
"tags": [
"tempo",
"change"
],
"departmentName": "HR",
"changeType": "Minor",
"targetEnvironment": "Test",
"subject": "TestExChange",
"description": "<p>Testing change.</p>",
"startDate": 1633343520000,
"endDate": 1635330720000,
"fileAttachments": [
]
}'
Response
{
"id": 5,
"name": "CHG-5",
"subject": "TestExChange",
"description": "Testing change.",
"createdTime": 1686027307917,
"updatedTime": 1686031832576,
"requesterEmail": "john@motadata.com",
"requesterName": "john",
"priorityName": "Medium",
"urgencyName": "Low",
"impactName": "Low",
"riskType": "Medium",
"changeType": "Minor",
"categoryName": "Network",
"locationName": "USA",
"tags": [
"change",
"tempo"
],
"departmentName": "HR",
"assigneeEmail": "john@motadata.com",
"targetEnvironment": "Test",
"startDate": 1633343520000,
"endDate": 1635330720000,
"fileAttachments": [],
"customField": {},
"statusName": "Requested"
}