POST method for deleting a case

Edit online

 V21.0.3 You can call this POST method to delete a case.

URI

/CASEREST/v1/deletecase

Request content for deleting a case

The request for the POST method contains the following parameters in JSON in the body. One of the casetype or caseid parameters must be passed.

{
    connectionpoint:"Name of the process engine connection point",
    casetype:"Symbolic name of the case type for which the cases are to be deleted. ",
     caseid : "The guid of the case instance which is to be deleted"
    tos:"Name of the target object store"
}

Request parameters

Table 1. Request parameters for the POST method
Name Type Required? Description
connectionpoint String Yes Name of the process engine connection point.
casetype String Yes Symbolic name of the case type for which the cases are to be deleted.
caseid String Yes The GUID of the case instance which is to be deleted.
tos String Yes Name of the target object store that contains the case to be deleted.
Follow the steps to find the connectionpoint value:
  1. Use the Administration Console for Content Platform Engine.
  2. Go to TargetObjectstore > Administrative > WorkflowSystem > Connection Points.
The value of deletecaseresult in the response JSON indicates whether the REST API for delete case was executed successfully. Check the IBM® Business Automation Workflow logs for further details.