get document content (Integration function)

This function is only available in connection with the document module (see Documents).


The get get document content (Integration function) function returns the content of a document stored in Lobster Data Platform / Orchestration (see Documents) starting from its ID (id), which is defined by parameter a.

Depending on parameter b, the document content is returned either as binary data (false/Standard) or as a Base64 encoded string.

images/download/attachments/201674009/image2020-10-8_16-31-6-version-1-modificationdate-1747044092810-api-v2.png

►NOTE◄

  • The document content is available for access by Lobster_data via the _pro get document content function, without consideration of role permissions, ownership and authorizations defined in Lobster Data Platform / Orchestration.

  • If there is no document using the ID addressed in parameter a at the time the function is called, the profile terminates with an error.

Parameter

Parameter

Description

Example

Note

a

ID (id) of a document

4711

Numerical value (long)

b

With the value true the document content is returned as a Base64 string,
otherwise as binary data.

true
false

Base64 content can for example be used in XML documents to embed binary files as strings.
The return of binary data returns the file content directly (like a download).

Example

The target field getDocumentContent is assigned content of the document with the internal ID (id) 1551 in Base64 encoding (b = true):

images/download/attachments/201674009/image2020-10-8_16-33-9-version-1-modificationdate-1747044092812-api-v2.png

  • Afterwards – for demonstration purposes – the _data function decode Base64 is used here to decode the content from the Base64 code back into the original format. The return value corresponds to the output that the get document content (Integration function) function would return with b = false.