Description | Use this endpoint to delete an object to the recycle bin or permanently. To delete a object permanently the query parameter hardDelete must be added with the value true. If a folder or register together with their children should be deleted a cascade deletion must be triggered with the query parameter cascadeDelete and the value true. With the query parameter hardDelete set it is also possible to delete objects permanently which are in the recycle bin. Here must also set the cascade deletion if a folder or register together with their child objects should be delete permanently. For the recycle bin there is also a own endpoint for deletion. |
|---|
Request
Method | DELETE |
|---|
Request optional Query Parameter | objectTypeId (String): The objectTypeId for the object to delete. This speed up the query. location (String): The object Id of the parent object of the child object with the given {objectId} to be deleted (specifying the parent's osid prevents errors should the child object have multiple locations). options (String): A comma-separated string with the following possible Job options: HARDDELETE: The object is not moved to trash it will be completely deleted DELETECASCADING: All of the object's children are also deleted. An error will be returned if this option isn't set and a not-empty folder or register is tried to be deleted.
hardDelete (Boolean): The object is not moved to trash it will be completely deleted cascadeDelete (Boolean): All of the object's children are also deleted. An error will be returned if this option isn't set and a not-empty folder or register is tried to be deleted.
|
|---|
Response
Statuscodes | Success: HTTP 204 No Content Error: HTTP/400 if the user is not allowed to delete the object if the user wants to permanently delete from recycle bin but has not the right to do it. if the user wants to permanently delete from recycle bin but has not the right to load the recycle bin at all.
Error: HTTP/404 if the object is not found Error: HTTP/500 if the enaio server job has failed processing.
|
|---|
Minimum Version | 3.0.0 |
|---|
Changelog | |
|---|
Request
Example | /api/dms/objects/2563?location=1411&cascadeDelete=true |
|---|