Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

As of Versionproduct version 1.0 | component version 1.0
Request MethodDELETE
Response FormatHTTP status code
Required Permission

action delete and read
>> Roles and Role Sets

Description

Deletes the object specified by objectId.A folder object can only be deleted if it has no child objects, means if there are no objects retrievable via yuuvis® Momentum API that have the specified objectId as value for the system:parentId property.

Objects under retention cannot be deleted (for more details click here).

As of 2023 Spring, the optional boolean query parameter waitForSearchConsistency (default true) is available.

Furthermore, the API gateway can be configured to support either synchronous deletion (default and behavior up to 2022 Winter) or asynchronous deletion.
>> serviceConfiguration.json

Synchronous Deletion

A successful response is returned as soon as:

  • the binary content files assigned to the current object or an old version are deleted from the repository (if no other object or object version refers to them),
  • the object's metadata is deleted from database and search index,
  • the metadata of all old object versions are deleted and
  • the entries 202 and 200 are created in the audit trail.

All previous audit entries for the deleted object remain in the database and can still be retrieved via search.

Asynchronous Deletion

A successful response is returned as soon as:

  • the object is flagged in the search index to be invisible and excluded from search results and
  • the entry 202 is created in the audit trail.

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 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 COMMANDER service using the maintain-delete command.

Request Example
/api/dms/objects/903f2ae8-2cfc-476c-8386-55c6811e41da
Result Exampleno response body
Response
Meaning of the response status codes:

200 OK

The DMS object with the ID objectId has been deleted

403 Forbidden

Insufficient permissions to perform a delete action.

404 Not Found

The DMS object with the ID objectId can not be found.

409 Conflict

The DMS object with the ID objectId could not be deleted due to retention (for more details click here).

  • No labels