Get the binary data for a variable

The response body contains the binary value of the variable. When the variable is of type binary, the content-type of the response is set to application/octet-stream, regardless of the content of the variable or the request accept-type header. In case of serializable, application/x-java-serialized-object is used as content-type.

get/cmmn-runtime/tasks/{taskId}/variables/{variableName}/data

Request

Base URL
https://developer-docs.flowable.com/cmmn-api
Auth
HTTP basic
TypeScript
https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/docs/cmmn-runtime/tasks/:taskId/variables/:variableName/data/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

taskIdstring required

variableNamestring required

Query parameters

scopestring

Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable.

Response

Indicates the task was found and the requested variables are returned.

string[] required

Changes

No recorded changes to this operation across all 1 revision of this API.