Industries Common Resources Developer Guide
jService Request Update Response
Status, updated fields, and field-level errors returned after a service catalog request
is updated.
JSON Example
1{
2 "status": "Failed",
3 "serviceRequestId": "0Aaxx0000004C92CAE",
4 "processTypeId": "500xx000000bqHpAAI",
5 "recordNumber": "00001234",
6 "processTypeObject": "Case",
7 "updatedFields": [],
8 "fieldErrors": [
9 {
10 "field": "Description",
11 "label": "Description",
12 "reasonCode": "WRONG_STATUS",
13 "currentStatus": "Closed",
14 "message": "This field can't be updated while the request is in 'Closed' status."
15 }
16 ]
17}Properties
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| fieldErrors | Field Error[] | One entry per attribute that couldn't be updated. The list is empty when there are no field-level errors, including when the whole request fails. | Small, 68.0 | 68.0 |
| processTypeId | String | ID of the process type (Case, Incident, or ServiceRequest). | Small, 68.0 | 68.0 |
| processTypeObject | String | Object type of the process type. | Small, 68.0 | 68.0 |
| recordNumber | String | Name or number of the process type. | Small, 68.0 | 68.0 |
| serviceRequestId | String | ID of the service catalog request that was updated. | Small, 68.0 | 68.0 |
| status | String | Outcome of the update. Possible values are Success or Failed. | Small, 68.0 | 68.0 |
| updatedFields | String[] | API names of the attributes that were successfully updated. | Small, 68.0 | 68.0 |