POST dms.response.objects.insert (Webhook)

Owned by Team Oktopus
Last updated: Nov 09, 2022 by Technische Redaktion
1 min read
As of Version2021 Summer
HTTP MethodPOST
Response FormatJSON
Description

Import requests trigger this webhook after successful import directly before the return.

The body contains the object list that will be returned. The body is modified by the webhook and returned afterwards.

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 EndpointThe target URL must be a POST endpoint accepting and returning a list of objects.
Affected API Requests

POST /api/dms/objects

Action Codes - History Codes

101 - OBJECT_CREATED_WITH_CONTENT

100 - OBJECT_CREATED

Called by ServiceRepository service
HeaderAuthorization-Header
Example Request Body
{
	"objects": [
		{
			"properties": {
				"system:objectId": {
					"value": "27602f73-7e3f-4013-babb-10a4dc042ff0"
				},
				"system:baseTypeId": {
					"value": "system:document"
				},
				"system:objectTypeId": {
					"value": "document"
				},
				"system:createdBy": {
					"value": "275c826c-6a61-4e89-9512-8d935a1631e5"
				},
				"system:creationDate": {
					"value": "2021-05-22T00:09:05.400Z"
				},
				"system:lastModifiedBy": {
					"value": "275c826c-6a61-4e89-9512-8d935a1631e5"
				},
				"system:lastModificationDate": {
					"value": "2021-05-22T00:09:05.400Z"
				},
				"system:versionNumber": {
					"value": 1
				},
				"system:tenant": {
					"value": "default"
				},
				"system:traceId": {
					"value": "f08d5290e5a81753"
				},
				"testString": {
					"value": "test import"
				}
			},
			"contentStreams": [
				{
					"contentStreamId": "EBC1760B-BA91-11EB-8277-D1DE73C78E3D",
					"archivePath": "default/DOCUMENT/BC/17/6/",
					"length": 431397,
					"mimeType": "message/rfc822",
					"fileName": "content.eml",
					"digest": "11857B6FAD61E41AFB3E7398BA1BA4BFB6B0A5422762FF41A0907BC0BFF7748F",
					"repositoryId": "repo242"
				}
			],
			"options": {
				"action": 101
			}
		}
	]
}
Example PredicateCheck if the object type is appEmail:email:

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

Check if at least one imported object has content: spel:options['action']==101