OpenText Developer Cloud public resources API Documentation
Get tasks
GET {{baseUrl}}/tasks?name=voluptate elit&nameLike=voluptate elit&description=voluptate elit&priority=voluptate elit&minimumPriority=voluptate elit&maximumPriority=voluptate elit&assignee=voluptate elit&assigneeLike=voluptate elit&owner=voluptate elit&ownerLike=voluptate elit&unassigned=voluptate elit&delegationState=voluptate elit&candidateUser=voluptate elit&candidateGroup=voluptate elit&candidateGroups=voluptate elit&involvedUser=voluptate elit&processInstanceId=voluptate elit&processInstanceIdWithChildren=voluptate elit&processInstanceBusinessKey=voluptate elit&processInstanceBusinessKeyLike=voluptate elit&processDefinitionId=voluptate elit&processDefinitionKey=voluptate elit&processDefinitionKeyLike=voluptate elit&processDefinitionName=voluptate elit&processDefinitionNameLike=voluptate elit&executionId=voluptate elit&createdOn=1951-08-14T20:08:23.047Z&createdBefore=1951-08-14T20:08:23.047Z&createdAfter=1951-08-14T20:08:23.047Z&dueOn=1951-08-14T20:08:23.047Z&dueBefore=1951-08-14T20:08:23.047Z&dueAfter=1951-08-14T20:08:23.047Z&withoutDueDate=true&excludeSubTasks=true&active=true&includeTaskLocalVariables=true&includeProcessVariables=true&includeTaskComments=true&includeTaskAssignments=true&candidateOrAssigned=voluptate elit&category=voluptate elit&filterByCurrentSubscription=true&offset=voluptate elit&count=voluptate elit&sort=name&order=desc&includeUserIds=false&includeGroupIds=false&sortEmptyValuesOnTop=true
Get tasks.
Body
PARAM
| Key | Datatype | Required | Description |
name
|
string | Only return tasks with the given name. | |
nameLike
|
string | Only return tasks with a name like the given name. | |
description
|
string | Only return tasks with the given description. | |
priority
|
string | Only return tasks with the given priority. | |
minimumPriority
|
string | Only return tasks with a priority greater than the given value. | |
maximumPriority
|
string | Only return tasks with a priority lower than the given value. | |
assignee
|
string | Only return tasks assigned to the given user. The assignee should be a valid user in the provided tenant and subscription context, user email id should be provided. | |
assigneeLike
|
string | Only return tasks assigned with an assignee like the given value. The assignee should be a valid user in the provided tenant and subscription context, and user email id should be provided. This parameter works only with user emails. | |
owner
|
string | Only return tasks owned by the given user. The owner should be a valid user in the provided tenant and subscription context, and user email id should be provided. | |
ownerLike
|
string | Only return tasks assigned with an owner like the given value. The owner should be a valid user in the provided tenant and subscription context, and user email id should be provided. This parameter works only with user emails. | |
unassigned
|
string | Only return tasks that are not assigned to anyone. If false is passed, the value is ignored. | |
delegationState
|
string | Only return tasks that have the given delegation state. Possible values are pending and resolved. | |
candidateUser
|
string | Only return tasks that can be claimed by the given user. This includes both tasks where the user is an explicit candidate for and task that are claimable by a group that the user is a member of. The candidateUser should be a valid user in the provided tenant and subscription context, and user email id should be provided. | |
candidateGroup
|
string | Only return tasks that can be claimed by a user in the given group. The group should be a valid application role or a group with associated user mappings in the provided tenant and subscription context, and application role name or group name should be provided. | |
candidateGroups
|
string | Only return tasks that can be claimed by a user in the given groups. Values split by comma. The group should be a valid application role or a group with associated user mappings in the provided tenant and subscription context, and application role name or group name should be provided. | |
involvedUser
|
string | Only return tasks in which the given user is involved. The involvedUser should be a valid user in the provided tenant and subscription context. | |
processInstanceId
|
string | Only return tasks which are part of the process instance with the given id. | |
processInstanceIdWithChildren
|
string | Only return tasks which are part of the process instance and its children with the given id. | |
processInstanceBusinessKey
|
string | Only return tasks which are part of the process instance with the given business key. | |
processInstanceBusinessKeyLike
|
string | Only return tasks which are part of the process instance which has a business key like the given value. | |
processDefinitionId
|
string | Only return tasks which are part of a process instance which has a process definition with the given id. | |
processDefinitionKey
|
string | Only return tasks which are part of a process instance which has a process definition with the given key. | |
processDefinitionKeyLike
|
string | Only return tasks which are part of a process instance which has a process definition with a key like the given value. | |
processDefinitionName
|
string | Only return tasks which are part of a process instance which has a process definition with the given name. | |
processDefinitionNameLike
|
string | Only return tasks which are part of a process instance which has a process definition with a name like the given value. | |
executionId
|
string | Only return tasks which are part of the execution with the given id. | |
createdOn
|
string | Only return tasks which are created on the given date. | |
createdBefore
|
string | Only return tasks which are created before the given date. | |
createdAfter
|
string | Only return tasks which are created after the given date. | |
dueOn
|
string | Only return tasks which are due on the given date. | |
dueBefore
|
string | Only return tasks which are due before the given date. | |
dueAfter
|
string | Only return tasks which are due after the given date. | |
withoutDueDate
|
boolean | Only return tasks which do not have a due date. The property is ignored if the value is false. | |
excludeSubTasks
|
boolean | Only return tasks that are not a subtask of another task. | |
active
|
boolean | If true, only return tasks that are not suspended (either part of a process that is not suspended or not part of a process at all). If false, only tasks that are part of suspended process instances are returned. | |
includeTaskLocalVariables
|
boolean | Indication to include task local variables in the result. | |
includeProcessVariables
|
boolean | Indication to include process variables in the result. | |
includeTaskComments
|
boolean | Indication to include task comments in the result. | |
includeTaskAssignments
|
boolean | Indication to include task assignments in the result. | |
candidateOrAssigned
|
string | Select tasks that has been claimed or assigned to user or waiting to claim by user (candidate user or groups).The candidateUser should be a valid user in the provided tenant and subscription context. The group should be a valid application role or a group with associated user mappings in the provided tenant and subscription context. | |
category
|
string | Select tasks with the given category. Note that this is the task category, not the category of the process definition (namespace within the BPMN Xml). | |
filterByCurrentSubscription
|
boolean | Only return the process tasks in the current subscription | |
offset
|
string | Start position value in the list of items, used for pagination. | |
count
|
string | Number of items to be limited in the response, used for pagination. By default the count value is set to 10. | |
sort
|
string | Property to sort on, to be used together with the order. To sort on process or task variables, make sure the variables are available in the response and provide the input to sort on variable:<variableName> | |
order
|
string | Order to be used together with the sort. | |
includeUserIds
|
boolean | Indication to include OTDS Id instead of email for users in the response. | |
includeGroupIds
|
boolean | Indication to include id instead of name for groups and roles in response. | |
sortEmptyValuesOnTop
|
boolean | If true, empty values are ordered at top of list. If false, empty values are ordered at bottom of list |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"assignee": "agerasim@opentext.come",
"category": "http://workflow-agerasimspace.dev.bp-paas.otxlab.net",
"claimTime": "2020-05-21T13:48:03.874Z",
"createTime": "2020-05-14T13:48:03.874Z",
"delegationState": "delegationState",
"description": "description",
"dueDate": "2020-05-24T13:48:03.874Z",
"executionId": "6e3b2222-e3a5-11eb-a263-eeee0aff14c1",
"formKey": "formKey",
"id": "88a73712-95e9-11ea-bf24-eeee0aff6560",
"name": "name",
"owner": "ownerName",
"parentTaskId": "8887a11e-95e9-11ea-bf24-eeee0aff6560",
"priority": "50",
"processInstanceId": "88877a0c-95e9-11ea-bf24-eeee0aff6560",
"suspended": "false",
"tenantId": "78c4a48b-0db9-420c-a573-88506dd72bf6",
"variables": "[]"
} |
Curl
curl -X GET 'baseUrl/tasks?name=voluptate elit&nameLike=voluptate elit&description=voluptate elit&priority=voluptate elit&minimumPriority=voluptate elit&maximumPriority=voluptate elit&assignee=voluptate elit&assigneeLike=voluptate elit&owner=voluptate elit&ownerLike=voluptate elit&unassigned=voluptate elit&delegationState=voluptate elit&candidateUser=voluptate elit&candidateGroup=voluptate elit&candidateGroups=voluptate elit&involvedUser=voluptate elit&processInstanceId=voluptate elit&processInstanceIdWithChildren=voluptate elit&processInstanceBusinessKey=voluptate elit&processInstanceBusinessKeyLike=voluptate elit&processDefinitionId=voluptate elit&processDefinitionKey=voluptate elit&processDefinitionKeyLike=voluptate elit&processDefinitionName=voluptate elit&processDefinitionNameLike=voluptate elit&executionId=voluptate elit&createdOn=1951-08-14T20:08:23.047Z&createdBefore=1951-08-14T20:08:23.047Z&createdAfter=1951-08-14T20:08:23.047Z&dueOn=1951-08-14T20:08:23.047Z&dueBefore=1951-08-14T20:08:23.047Z&dueAfter=1951-08-14T20:08:23.047Z&withoutDueDate=true&excludeSubTasks=true&active=true&includeTaskLocalVariables=true&includeProcessVariables=true&includeTaskComments=true&includeTaskAssignments=true&candidateOrAssigned=voluptate elit&category=voluptate elit&filterByCurrentSubscription=true&offset=voluptate elit&count=voluptate elit&sort=name&order=desc&includeUserIds=false&includeGroupIds=false&sortEmptyValuesOnTop=true?name=voluptate elit&nameLike=voluptate elit&description=voluptate elit&priority=voluptate elit&minimumPriority=voluptate elit&maximumPriority=voluptate elit&assignee=voluptate elit&assigneeLike=voluptate elit&owner=voluptate elit&ownerLike=voluptate elit&unassigned=voluptate elit&delegationState=voluptate elit&candidateUser=voluptate elit&candidateGroup=voluptate elit&candidateGroups=voluptate elit&involvedUser=voluptate elit&processInstanceId=voluptate elit&processInstanceIdWithChildren=voluptate elit&processInstanceBusinessKey=voluptate elit&processInstanceBusinessKeyLike=voluptate elit&processDefinitionId=voluptate elit&processDefinitionKey=voluptate elit&processDefinitionKeyLike=voluptate elit&processDefinitionName=voluptate elit&processDefinitionNameLike=voluptate elit&executionId=voluptate elit&createdOn=1951-08-14T20:08:23.047Z&createdBefore=1951-08-14T20:08:23.047Z&createdAfter=1951-08-14T20:08:23.047Z&dueOn=1951-08-14T20:08:23.047Z&dueBefore=1951-08-14T20:08:23.047Z&dueAfter=1951-08-14T20:08:23.047Z&withoutDueDate=true&excludeSubTasks=true&active=true&includeTaskLocalVariables=true&includeProcessVariables=true&includeTaskComments=true&includeTaskAssignments=true&candidateOrAssigned=voluptate elit&category=voluptate elit&filterByCurrentSubscription=true&offset=voluptate elit&count=voluptate elit&sort=name&order=desc&includeUserIds=false&includeGroupIds=false&sortEmptyValuesOnTop=true'
ENDPOINTS