This API is available to delete the specimen.
Api :
Method | URL |
---|---|
DELETE | catissuecore/rest/ng/specimens/{specimen_id}?includeChildren={true/false} |
Request | application /json |
Response | "success" |
Parameter Details :
{specimen_id} : Specimen Id.
includeChildren: with this variable client can specify that whether to delete this specimen only or to delete all including child specimens.
default value: false, permissible values: true/false
Error Cases :
code | Applies to | Status Message |
---|---|---|
200 | All resources | Specimen has been deleted successfully |
400 | All requests | If any active children found for this Specimen |
401 | All requests | Authorization failed, User doesn’t have privileges to delete this specimen |
404 | All requests | Specimen not found, Specimen with given identifier is not present in the system |
500 | All requests | Internal server error, Encountered server error while performing operations |