4.14 Remove External Entity from Case
This service will allow updation of risk decision for events in existing case.
The following topics explain how to remove External Entities from an existing Case.
- HTTP Link
- Service Type
- Request Parameters
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http:// <Application
URL>/rest-api/ECMService/CaseManagementService/removeExternalEntity
Service Type
The service type is POST.
Request Parameters
Table 4-27 Request Parameter Details
First Level | Second Level | Details |
---|---|---|
caseId | - | This accepts the case internal identifier. |
externalEntities | externalEntity | This accepts the external entity internal identifier. |
externalEntities | externalEntityTypeCode | This accepts the external entity type code value. |
Request JSON Sample
This section contains a request JSON sample to remove external Entities from an existing case. The API will accept multiple caseids and external entities information to be removed from the case. The entries in this sample are only for reference purposes.
[
{
"caseId": "CA100",
"externalEntities": [
{
"externalEntity": "ACFTNETRSTACO1X",
"externalEntityTypeCode": "XA"
}
]
}
]
Response Parameters
Table 4-28 Parameter Details
First Level | Second Level | Third Level | Details |
---|---|---|---|
MESSAGE | - | - | Displays the overall response message from the API. |
STATUS | - | - | Displays the overall 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 and in case of partial success it will be represented by PARTIALSUCCESS. |
RESULTARRAY | MESSAGE | - | Displays the response message from the API for the respective case. |
RESULTARRAY | STATUS | - | Displays the status of the API call for the respective case 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 and in case of partial success it will be represented by PARTIALSUCCESS. |
RESULTARRAY | caseId | - | Displays the case internal identifier on which the API was called. |
RESULTARRAY | externalEntities | MESSAGE | Displays the response message from the API for the respective external entity under the respective case. |
RESULTARRAY | externalEntities | STATUS | Displays the status of the API call for the respective external entity under the respective case 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. |
RESULTARRAY | externalEntities | externalEntity | Displays the external entity internal identifier under the respective case on which the API was called. |
Response JSON Sample
{
"MESSAGE": "External Entities removal was successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "External Entities removal was successful.",
"STATUS": "SUCCESS",
"caseId": "CA100",
"externalEntities": [
{
"MESSAGE": "External Entity removed successfully.",
"STATUS": "SUCCESS",
"externalEntity": "ACFTNETRSTACO1X"
},
{
"MESSAGE": "External Entity removed successfully.",
"STATUS": "SUCCESS",
"externalEntity": "TERRY FRANCONA"
}
]
}
]
}