Delete a Single Infoton¶
Description¶
You can delete a single infoton by applying the REST DELETE command to the infoton's URI.
Syntax¶
URL: Infoton's URI.
REST verb: DELETE
Mandatory parameters: N/A
Template:
curl -X DELETE <cm-well-host>/<cm-well-path>
URL example: N/A
Curl example (REST API):
curl -X DELETE <cm-well-host>/example.org/Individuals/JohnSmith
Special Parameters¶
| Parameter | Description | Values | Example | Reference |
|---|---|---|---|---|
| recursive | If true, queries and delete command are recursive, i.e. will apply to all infotons who are path-wise descendants of the infotons in the request. (An equivalent but deprecated flag name is with-descendants.) |
false / true (the default) | recursive=true | N/A |
Code Example¶
Call¶
curl -X DELETE <cm-well-host>/example.org/Individuals/JohnSmith
Results¶
{"success":true}
Note
- CM-Well returns a "success" status code even if the infoton you requested to delete doesn't exist.
- Applying the DELETE command to an infoton actually just marks the infoton as deleted, but leaves it in CM-Well storage. If you need to permanently remove infotons from CM-Well, see the purge operation.
- When the recursive flag is used, the request may fail if there are too many descendants to delete in a reasonable amount of time.