POST dms.request.objects.delete (Webhook)

As of Version 2021 Summer

HTTP Method POST

Response Format JSON

Description

The webhook is triggered if the object or version to delete exists and is deletable, i.e., if the user has sufficient permissions and if the object is not a non-empty folder.

The body contains an object list with the active version or the version to delete of the object(s).

The predicate is applied to every single object in the list. The webhook is triggered for the whole object list as soon as one object satisfies the predicate.

Requirements for External Endpoint The target URL must be a POST endpoint accepting and returning a list of objects.

Affected API Requests and Action Codes/History Codes

DELETE /api/dms/objects/{objectId} DELETE /api/dms/objects	200 - OBJECT_DELETED
DELETE /api/dms/objects/{objectId}/versions/{versionNr}	220 - VERSION_DELETED

Restart Service API-gateway service

Header Authorization-Header

Example Request Body

{
	"objects": [
		{
			"properties": {
				"system:traceId": {
					"value": "adcb4edd823fca4c"
				},
				"system:objectTypeId": {
					"value": "document"
				},
				"system:versionNumber": {
					"value": 3
				},
				"testString": {
					"value": "new test import"
				},
				"system:createdBy": {
					"value": "275c826c-6a61-4e89-9512-8d935a1631e5"
				},
				"system:creationDate": {
					"value": "2020-07-23T13:12:34.370Z"
				},
				"system:lastModificationDate": {
					"value": "2020-07-23T13:12:35.910Z"
				},
				"system:baseTypeId": {
					"value": "system:document"
				},
				"system:tenant": {
					"value": "default"
				},
				"system:lastModifiedBy": {
					"value": "275c826c-6a61-4e89-9512-8d935a1631e5"
				},
				"system:objectId": {
					"value": "9ce1ab26-1a6b-4bc2-aa4b-2b099bff7468"
				}
			},
			"contentStreams": [
				{
					"contentStreamId": "4710AB82-C1B4-11EA-B395-49C30F249D00",
					"archivePath": "default/DOCUMENT/71/0A/B/",
					"length": 431397,
					"mimeType": "application/octet-stream",
					"digest": "11857B6FAD61E41AFB3E7398BA1BA4BFB6B0A5422762FF41A0907BC0BFF7748F",
					"repositoryId": "repo252"
				}
			],
			"options": {
				"action": 200,
				"detail": "OBJECT_DELETED",
				"tenant": "default",
				"user": "root",
				"authorities": [
					"ACL_ADMIN",
					"YUUVIS_TENANT_ADMIN",
					"uma_authorization"
				]
			}
		}
	]
}

Example Predicate

Check if the object type is appEmail:email:

spel:'appEmail:email'.equals(properties['system:objectTypeId']['value'])