DELETE /documents/r1/files/{fileUuid}

Business Logic

This API deletes a file version. The deletion is always logical: the deleted flag of the target file version is set to true. Optionally, if the physicalDeletion query parameter is set to true, the associated physical file is also permanently removed from the storage.

The deletion process steps are:

1. Validation:

   • The fileUuid path parameter is validated as mandatory.

2. File Loading:

   • If no version is specified, the main version of the file is loaded (i.e., the currently active version, or the latest one if no active version is available).

   • If a specific version is provided, that exact version is loaded.

   • If no matching file is found, a NOT_FOUND error is returned.

3. Logical Deletion:

   • The deleted flag of the loaded file version is set to true and the record is updated.

4. Physical Deletion (optional):

   • If physicalDeletion is true, the physical file at the stored path is located and permanently deleted from the storage.

   • If the physical file cannot be found or an error occurs during deletion, an appropriate error is returned.

5. Notification:

   • A delete notification event is dispatched after the operation completes successfully.

Path Parameters

Query String Parameters

Header Parameters

Default.

Response documentation

Response error codes

BASE_0001, NOT_FOUND