Get Single Variable Instance (Binary)

Retrieves the content of a single variable by id. Applicable for byte array and file variables.

Method

GET /variable-instance/{id}/data

Parameters

Path Parameters

Name Description
id The id of the variable instance.

Result

For binary variables or files without any mime type information a byte stream is returned. File variables with mime type information are returned as the saved type. Additionally, for file variables the Content-Disposition header will be set.

Response codes

Code Media type Description
200 application/octet-stream
or
the saved mime type
Request successful.
400 application/json Variable with given id exists but does not serialize as binary data. See the Introduction for the error response format.
404 application/json Variable with given id does not exist. See the Introduction for the error response format.

Example

Request

GET /variable-instance/someId/data

Response

binary variable: Status 200. Content-Type: application/octet-stream

file variable: Status 200. Content-Type: text/plain; charset=UTF-8. Content-Disposition: attachment; filename=“someFile.txt”

On this Page: