Edit closed case

Overview

Use this API to modify the custom attributes of a closed case. Users can only modify one case at a time.

For this API to execute successfully:

  • A case with the ID specified in the request body must exist.
  • The status of the specified case must be 'closed'.

Permissions

All of the following are required:

  • Must have 'Manage closed case' action on the 'Case' resource.
  • The case must either belong to the user's home department, or to a department in which the user is a foreign user.
SecurityoAuthUser or oAuthClient
Request
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema: application/json

Elements required in request body

id, lastModified, customAttributes

Note: To remove value of any element of type "String", set the value to an empty string (instead of setting the value to null).

lastModified
required
string <date-time> (lastModified)

Last modified date of the case.

required
object (customAttributes)

Name and value of all the custom attributes configured for the Case Object.

id
required
string (id)

Case ID.

lastClosed
string <date-time> (lastClosed)

Last closed date of the closed case.

Responses
204

No content

400

Bad Request message

401

Unauthorized

403

Forbidden

406

Not Acceptable

409

Conflict

500

Internal server error

patch/case/closed
Request samples
application/json
  • PATCH /core/casemgr/v3/case
  • This example demonstrates the following:
    • Editing all required elements of a closed case.
{
  • "id": "1004",
  • "lastModified": "2019-05-02T14:36:51.000Z",
  • "customAttributes": {
    }
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}