DELETE /api/dms/objects/{objectId}/contents/file

Owned by Technische Redaktion
Last updated: May 16, 2023
1 min read
As of Versionproduct version 2023 Summer
Request MethodDELETE
Response FormatJSON
Required Permission

action write and read
>> Roles and Role Sets

Note: The process is internally handled like a content update and therefore does NOT require a delete permission.

Description

Removes the binary content file from the DMS object specified by objectId.

A new object version without the contentStreams properties section will be created. For the previous version(s), the corresponding binary content file remains. To the object's audit trail, an entry with action 201 and detail OBJECT_CONTENT_DELETED will be added.

In addition to the above mentioned permissions, the DMS object has to match following requirements:

As the process is internally handled like a content update, the corresponding webhook entry points are passed.

Request Example

DELETE /api/dms/objects/6200fcc9-d6b4-43c0-82e7-ac1ed2fa8350/contents/file

Result Example


The result is a JSON structure containing the updated metadata of the object identified by objectId.

{
    "objects": [
        {
            "properties": {
                "system:objectId": {
                    "value": "6200fcc9-d6b4-43c0-82e7-ac1ed2fa8350"
                },
                "system:baseTypeId": {
                    "value": "system:document"
                },
                "system:objectTypeId": {
                    "value": "document"
                },
                "system:secondaryObjectTypeIds": {
                    "value": [
                        "system:rmDestructionRetention"
                    ]
                },
                "system:createdBy": {
                    "value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
                },
                "system:creationDate": {
                    "value": "2018-09-10T14:35:36.657Z"
                },
                "system:lastModifiedBy": {
                    "value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
                },
                "system:lastModificationDate": {
                    "value": "2018-09-10T15:03:17.099Z"
                },
                "system:versionNumber": {
                    "value": 3
                },
                "system:tenant": {
                    "value": "tenant1"
                },
                "system:traceId": {
                    "value": "7589750308987031207"
                },
                "Name": {
                    "value": "Menschenskinder"
                }
            }
        }
    ]
}