POST dms.request.objects.contents (Webhook)

As of Version 2022 Winter

HTTP Method POST

Response Format JSON

Description

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 HTTP status code 404 and a properly formatted error message to prohibit the content/rendition retrieval. This HTTP status code and your custom error message will finally be presented as response of the originally called endpoint.
If your webhook returns any other HTTP status code or if the error message does not match the expected format, the content retrieval fails with HTTP status code 422. The error message provided by the webhook is wrapped to match our format.

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

REPOSITORY service

Header Authorization-Header

Example Request Body

{
  "objects": [{
    "properties": {
      "system:objectTypeId": {
        "value": "object"
      },
      "label": {
        "value": "Label"
      },
      "subentitaet": {
        "value": "Sub"
      },
      "idn": {
        "value": "6754"
      },
      "titel": {
        "value": "Titel"
      },
      "medientyp": {
        "value": "Cool filename"
      } 
    },
    "contentStreams": [{
      "cid": "cid_63apple",
      "mimeType": "application/pdf",
      "fileName" : "document01.pdf"
    }],
    "options": {
      "action": 400,
      "detail": "DOCUMENT_ACCESSED",
      "tenant": "tenant1"
    } 
  }]
}

Example Predicate