POST method for deleting a case instance

Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15

You can call this POST method to delete a case instance.

URI

/CASEREST/v1/deletecase

Request content for deleting a case instance

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 Content Cortex process engine connection point.
casetype	String	Yes. Only if all the cases from the case type are to be deleted.	The symbolic name of the case type for which the cases are to be deleted.
caseid	String	Yes. Only if one case is to be deleted.	The GUID of the case instance, which is to be deleted.
tos	String	Yes	The name of the target object store that contains the case to be deleted.

Follow the steps to find the connectionpoint value:

Use the Administration Console for Content Platform Engine.
Go to TargetObjectstore > Administrative > WorkflowSystem > Connection Points.

The value of deletecaseresult in the response JSON indicates whether the REST API for delete case instance was run successfully. Check the IBM® Business Automation Workflow logs for further details.

Note:

This case REST method deletes the case instance and all associated activity processes. Documents that are associated with the case instance remain intact; only the references to the case folders are removed.
If a document is filed in only one case instance folder, the REST API removes the document. However, if the document is referenced elsewhere outside the case instance, the document is only unfiled from the case instance folder.