Task Variables

Get a variable from a task

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

Request

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.

namestring

Name of the variable

typestring

Type of the variable.

valueobject

Value of the variable.

valueUrlstring
scopestring

Example response

{
  "name": "myVariable",
  "type": "string",
  "valueUrl": "http://...."
}

Changes

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