Get Single Case Instance Variable (Binary)

Retrieves a binary variable of a given case instance. Applicable for byte array and file variables.

Method

GET /case-instance/{id}/variables/{varId}/data

Parameters

Path Parameters

Name Description
id The id of the case instance to retrieve the variable from.
varId The name of the variable to get.

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 is not a binary variable. 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 /case-instance/aCaseInstanceId/variables/aVarName/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: