Returns the list of task variables
POST {{tasklistApiBaseUrl}}/v1/tasks/:taskId/variables/search
This method returns a list of task variables for the specified taskId
and variableName
.
If the request body is not provided or if the variableNames
parameter in the request is empty, all variables associated with the task will be returned.
Request Body
{"state"=>"CREATED", "assigned"=>true, "assignee"=>"string", "assignees"=>["string"], "taskDefinitionId"=>"string", "candidateGroup"=>"string", "candidateGroups"=>["string"], "candidateUser"=>"string", "candidateUsers"=>["string"], "processDefinitionKey"=>"string", "processInstanceKey"=>"string", "pageSize"=>0, "followUpDate"=>{"from"=>"2024-04-03T03:24:08.849Z", "to"=>"2024-04-03T03:24:08.849Z"}, "dueDate"=>{"from"=>"2024-04-03T03:24:08.849Z", "to"=>"2024-04-03T03:24:08.849Z"}, "taskVariables"=>[{"name"=>"string", "value"=>"string", "operator"=>"eq"}], "tenantIds"=>["string"], "sort"=>[{"field"=>"completionTime", "order"=>"ASC"}], "searchAfter"=>["string"], "searchAfterOrEqual"=>["string"], "searchBefore"=>["string"], "searchBeforeOrEqual"=>["string"], "includeVariables"=>[{"name"=>"string", "alwaysReturnFullValue"=>false}], "implementation"=>"JOB_WORKER"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e","isValueTruncated":"\u003cboolean\u003e","previewValue":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e","isValueTruncated":"\u003cboolean\u003e","previewValue":"\u003cstring\u003e"}]