Page Comparison

Page Properties

hidden	true
id	DONE

Product Version
Report Note
Assignee	Antje

Resources & Remarks

Modification History

Name	Date	Product Version	Action
Antje	22 NOV 2022	2022 Winter	page created

...

As of Version 2022 Winter

HTTP Method POST

Response Format JSON

Description

Excerpt
A webhook of this type can be triggered by a request for retrieval of a binary content file or a rendition.

The original body that is available at the webhook entry point is an object list containing the object for which the content/rendition should be retrieved and the corresponding options properties.

Requirements for External Endpoint

The target URL must be a POST endpoint accepting and returning a list of objects. The following responses are expected:

Return HTTP status code 200 to continue with the content/rendition retrieval. Changes in the body introduced within the webhook are ignored.
Return any other HTTP status code 404 and a properly formatted error message structure in the body to prohibit the content/rendition retrieval. This HTTP status code and your custom error message Your error structure will finally be presented as response of the originally called endpoint with HTTP status code 404.
If your webhook returns any other HTTP status code or if the error message an error structure that does not match the expected format, the content retrieval fails with HTTP status code 422. The webhook error message provided by the webhook is wrapped to match our formatas plain text.

>> Error Handling

Affected API Requests and Action Codes/History Codes

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

GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/file

GET /api/dms/objects/{objectId}/contents/renditions/pdf

400 - DOCUMENT_ACCESSED

GET /api/dms/objects/{objectId}/contents/renditions/text

402 - RENDITION_TEXT_ACCESSED

GET /api/dms/objects/{objectId}/contents/renditions/pdf

GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/pdf

403 - RENDITION_PDF_ACCESSED

Called by Service

API Gateway

Header Authorization-Header

Example Request Body

Code Block

language	yml

{
    "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": 400,
                "detail": "DOCUMENT_ACCESSED",
                "tenant": "default",
                "system:hook:type": "dms.request.objects.contents",
                "system:request:method": "GET"
            }
        }
    ]
}

Example Predicate

...

Versions Compared

Old Version 2

New Version 3

Key