Lexware Office icon

Lexware Office

Interact with the full Lexware Office (lexoffice) API

Actions48

File → Download

AI-generated

Summary

Downloads a file from Lexware Office by its ID and returns it as binary data.

Inputs

  • id (required) — ID of the file to download (from the File resource).
  • binaryPropertyName — Name of the binary property where the downloaded file will be stored. Defaults to 'data'.

Output shape

An object with a json field containing the file ID and a binary field containing the file data under the property name specified by binaryPropertyName.

The json output is { id: <file-id> }. The binary output is { [<binaryPropertyName>]: <file-buffer> }.

Examples

Example 1: Download a file with ID 'abc123' and store it in the default binary property 'data'.

Resource: File, Operation: Download, ID: abc123, Binary Property: data

Links

Discussion