DELETE /api/dms/objects/{objectId}
As of Version | product version 1.0 | component version 1.0 |
---|---|
Request Method | DELETE |
Response Format | HTTP status code |
Required Permission | action |
Description | Deletes the object specified by Objects under retention cannot be deleted (for more details click here). As of 2023 Summer, the optional query parameter As of version 2023 Spring, the API gateway can be configured to support either synchronous deletion (default and behavior up to version 2022 Winter) or asynchronous deletion. Synchronous DeletionA successful response is returned as soon as:
All previous audit entries for the deleted object remain in the database and can still be retrieved via search. Asynchronous DeletionA successful response is returned as soon as:
All previous audit entries for the invisible object remain in the database and can still be retrieved via search. Metadata and binary content are still stored in the search index, database and repository. However, for the users, they are considered as irrevocably deleted. They can be finally removed by a background process, e.g., via the COMMANDER service using the maintain-delete command. |
Request Example |
|
Result Example | no response body |
Response | Meaning of the response status codes: 200 OKThe DMS object with the ID objectId has been deleted. 403 ForbiddenInsufficient permissions to perform a delete action. 404 Not FoundThe DMS object with the ID objectId cannot be found. 409 ConflictUnable to delete the DMS object with the ID objectId (e.g., due to retention - for more details click here). |