PATCH Update a Request
URL: {{server-url}}/api/v1/request/{{request-Id}}
You can update the details of an existing request ticket by calling the above endpoint with the request 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 |
---|---|---|
subject* | String | Subject of the ticket. |
categoryName | String | Category Name of a Request. Set to ‘Request’ as it is default to ‘Service Request’. |
ccEmailSet | String Array | Email Address of People to whom notification is to be sent for certain events on Request. |
tags | String Array | These are additional identifiers attached to a ticket. It is a list that can contain n number of STRINGS. |
impactName | String | Describes the effect of the Request. Possible values are: Low, On User , On department, Or On Business. |
priorityName | String | Shows the importance of the Request. Possible values are: Low, Medium, High, or Urgent. |
urgencyName | String | Marks the request as urgent. Possible values are: Low, Medium, High, or Urgent. |
departmentName | String | Additional information about the ticket. |
locationName | String | Name of the Location where Request happened. Note that Location Must Exist with same name. |
supportLevel | String | Describes the level of the provisioned support. Possible Values are: Tier1, Tier2, Tier3, or Tier 4. |
Assignee Email | String | Name of the Assignee. |
Technician Group Name | String | Name of the group to which the Technician belongs. |
spam | Boolean | Possible Values are True or False. |
fileAttachments | Object Array | Reference File Name of attachments for a Request. For example:[ { “refFileName” : “abc”, “realName” : “xyz.pdf” } ] |
statusName | String | Possible values are Open, In Progress, Pending, Resolved, and Closed. |
customField | MAP:{key: STRING, value: OBJECT} | This key is related to custom fields. Example “customField”: {“New Dropdown”: “1”, “New Number”: 110.1,”New Text Area”: “a11”, “New Text Input”: “111”} |
Example (Request & Response)
Request
curl --request PATCH \
--url 'http://{{server-url}}/api/request/{{request-Id}}' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiJqb2huQGZsb3RvbWF0ZS5jb20iLCJzY29wZSI6WyJvdGhlci1hcGktc2NvcGUiXSwiZXhwIjoxNTM2MjM4NjYwLCJhdXRob3JpdGllcyI6WyJVU0VSIl0sImp0aSI6IjAzZGI3ZmI0LTVmNjUtNGM2Ny1hZTJkLTk4ODkyYzRiNzI3NyIsImNsaWVudF9pZCI6IlRyaXBBcHAtY2xpZW50In0.frXc5yUhA2QDRmTEQW9\_kqQV0y7zjqImYMLMqzf2pZ8' \
--header 'Content-Type: application/json' \
--data '{
"statusName":"Resolved"
}'
Response
{
"id": 1,
"createdTime": 1584699527485,
"updatedTime": 1584699528033,
"requesterEmail": "a@b.com",
"requesterName": "utsav",
"ccEmailSet": [
"a@b.com"
],
"subject": "asdasd",
"impactName": "Low",
"priorityName": "Low",
"statusName": "Open",
"urgencyName": "Low",
"tags": [],
"customField": {},
"source": "Technician Portal",
"spam": false,
"departmentName": "IT",
"supportLevel": "tier1",
"name": "INC-1"
}