updatecase
/updatecase
V1.0
Description
Updates a given case’s reportable Attribute
in iCasework with the provided Value
. A case identifier (CaseId
or ExternalId
) must be supplied. In addition to the parameters below, the API can be extended to update additional case attributes. The names of Attribute
s that can be updated with this service, can be found in reporting; also your iCasework representative can provide the values to use for specific attributes in your configuration.
Request Method
POST
API Service endpoints
UAT: https://uat.icasework.com/updatecase?db=[youriCaseworkAccount]
eUAT / Production system: https://[youriCaseworkAccount].icasework.com/updatecase
Your iCasework account name will be supplied to you by your iCasework Account or Project Manager
Request Parameters
Parameter | Description | Values | Required value? |
---|---|---|---|
CaseId | The internal identifier for the case you wish to update | "324234321" | No. |
ExternalId | The external identifier for the case you wish to update | "4657845" | No. |
Format | Defines the format of the API response. The default value is "xml" | "xml" or "json" | No. |
Attribute | The name of the reportable attribute to be updated | “Details” | No. |
Value | The value to update that reportable attribute | “This documentation is great” | No. |
Example
Request
<https://example.icasework.com/updatecase>
{
"CaseId": "321123",
"Format": "json",
"isVulnerable": "true",
"numberOfPets": "12"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CaseId>321123</CaseId>
<Format>json</Format>
<isVulnerable>true</isVulnerable>
<numberOfPets>12</numberOfPets>
Response
<?xml version="1.0" encoding="UTF-8"?>
<updatecaseattributeresponse>
<caseid>abc1234</caseid>
</updatecaseattributeresponse>
{
"updatecaseattributeresponse": {
"caseid": "511234"
}
}
HTTP 400 responses
X-Application-Error-Code | X-Application-Error-Info | Troubleshooting tips |
---|---|---|
11000 | Invalid HTTP method | Check the HTTP method of the request; this should be a POST |
11001 | API not available here | Check the endpoint of the request |
11002 | Unable to identify case. Please provide a valid value for parameter CaseId or ExternalId. | Pass a value for |
11005 | Unable to identify case. Please provide a valid value for parameter CaseId or ExternalId. | Pass a valid value for |
HTTP 403 responses
X-Application-Error-Code | X-Application-Error-Info | Troubleshooting tips |
---|---|---|
11021 | Incorrect key or signature | Check the authentication method of the request |
11021 | Invalid token (6) | Check the authentication method of the request |
11022 | Insufficient privileges for updating customer details | Check that there is a power user associated with the API key and this user is a member of the same workspace that the target case is in. |
Civica 2020. All Rights Reserved