Get Local Case Execution Variable (Binary)
Retrieves a binary variable from the context of a given case execution. Does not traverse the parent case execution hierarchy. Applicable for byte array and file variables.
Method
GET /case-execution/{id}/localVariables/{varName}/data
Parameters
Path Parameters
| Name | Description |
|---|---|
| id | The id of the case execution to retrieve the variable from. |
| varName | 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 orthe 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-execution/aCaseExecutionId/localVariables/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”