This API allows user to modify an existing case. Only one case can be modified at a time.
A case can be related to a maximum of 75 other cases.
For this API to execute successfully:
Method | URL | Description |
---|---|---|
PUT | /ws/v12/interaction/case | Modify an existing case |
Authentication is required. The client must be logged in to call this API. Each API request must contain X-egain-session request header returned by Login API.
The logged in user must have the following licenses:
Name | Description | Allowed values | Default value |
---|---|---|---|
X-egain-session | Session ID obtained from Login API response header | N/A | N/A |
Accept | Content type accepted by client. | application/xml or application/json | N/A |
Content-Type | Media type sent by the client | application/xml or application/json | N/A |
Accept-Language | Language locale accepted by client (used for locale specific fields in resource representation and in error responses) | Supported 'Accept-Language' header codes | default system language |
The request body is mandatory. Request body can be in either XML or JSON format.
Name | Description |
---|---|
id | ID of the Case. |
lastModified.date | Value of last Modified date of the case. |
Name | Description |
---|---|
dueDate | If provided, must be a future date. Refer supported date format here. If value is not provided, the due date for the case is removed. |
owner.user.id | Must be an ID of a user in the application. |
severity.value | Must be one of 'urgent', 'high', 'medium', or 'low'. |
subject | Must not exceed 1024 characters. |
description | Must not exceed 1024 characters. |
solution | Must not exceed 1024 characters. |
relatedCases | Relationship with other cases. The case can be related with other cases. Existing relationship with other cases can be removed as well. No more than 75 cases can be linked with a case. |
customAttributes | Name must match one of the custom attributes configured in application. If the custom attribute is configured as an enumeration, the value must be one of the predefined values. For string type of custom attribute that is not configured as an enumeration, refer list of Allowed Characters For Custom Attributes. |
NOTE: To remove value of any element of type "String", set the value to an empty string (instead of setting the value to null).
None
None
Name | Description | Possible values |
---|---|---|
X-egain-session | ID of the current user session | N/A |
Content-Type | Media type of response body | application/xml or application/json |
The response body will be sent only in case of error. It can be in either XML or JSON format.
204 - No Content
400 - Bad Request
401 - Unauthorized
403 - Forbidden
406 - Not Acceptable
409 - Conflict
500 - Internal server error
Example 1 - Modify all allowed elements of a case
Example 2 - Modify case to remove attribute values