4.6 Create or Update Case Description
This service allows the Case Description to be added or updated. Any change will lead to an update to the audit history.
- HTTP Link
- Service Type
- Request Parameters
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http:// <Application
URL>/rest-api/ECMService/CaseManagementService/updateCaseDescription
Service Type
The service type is POST.
Request Parameters
Table 4-11 Create Event and Extend to Existing Case - Request Parameters
First Level | Details |
---|---|
caseId | This accepts the case internal identifier. |
caseDescription | This accepts information about the description of the case. |
Request JSON Sample
This section contains a request JSON sample for creating or updating case description. The API will accept the case id for which the description needs to be updated and the case description. The entries in this sample are only for reference purposes.
{
"caseId": "CA100",
"caseDescription": "This case was created because of suspicious events reported on the customer."
}
Response Parameters
Table 4-12 Parameter Details
First Level | Details |
---|---|
Message | Displays the response message from the API. |
Status | Displays the status of the API call whether it was successful or failed. In case of success, it will be represented by SUCCESS, and in case of failure it will be represented by FAILED |
caseId | Displays the case internal identifier on which the API was called. |
Response JSON Sample
{
"MESSAGE": "Case description updated successfully.",
"STATUS": "SUCCESS",
"caseId": "CA100"
}