Theme switcher

List tasks of the current user

Header Parameters

Authorizationstring

Keycloak access token (OAuth2). Replace [HOST] and [YOUR_REALM] with the values of your installation. OAuth2 flows: Implicit (authorization URL: https://[HOST]/realms/[YOUR_REALM]/protocol/openid-connect/auth)

Query Parameters

querystring

Search text, minimum 3 characters. Matches task name, business key and process name (contains, case-insensitive).

scopestring

Which tasks to return:

  • mytasks: tasks claimed by the user.
  • taskofteam: unclaimed tasks of the user's groups, without tasks the user is excluded from.
  • all: mytasks plus all unclaimed tasks and tasks of the user's groups, without excluded ones.
  • admin: tasks where the user or one of the user's groups is admin.
Default value
all
Enum values:
mytaskstaskofteamalladmin

Response

200
Object

Tasks.

Response Attributes

_idstring

Technical MongoDB document id. Not a business identifier - do not use it to address objects.

eccTypestring

Object type, e.g. process, task, history, process_history, process_node, event.

eccClassnamestring

Java class name of the object.

idstring

Unique id of the task instance.

descriptionstring

Task description from the BPMN model.

namestring

Task name from the BPMN model. Also used to find the task page in the frontend.

prioritystring

Task priority.

statestring

Lifecycle state: Ready, Reserved, InProgress, Completed, Skipped, Obsolete, Error.

iconstring

Suggested icon key, derived from state (processObject=tasks only), e.g. userTask-ready, userTask-reserved.

startedstring

Creation time of the task.

completedstring

Completion time.

lastUpdatestring

Time of the last change.

slaDueDatestring

Due date, if defined.

referenceNamestring

Reference name of the task node in the BPMN model.

externalReferenceIdstring

External reference id, if set by the engine.

endpointstring

REST endpoint of the task in the BPM engine.

nodeInstanceIdstring

nodeInstanceId of the userTask node this task belongs to (from the BPM engine's process history).

commentstring

Comment/subject configured for the task node in the BPMN model (from workItem.input, not the userTask object).

contentstring

Content/body configured for the task node in the BPMN model (from workItem.input, not the userTask object).

groupIdstring

Group id the task was created for (from workItem.input, not the userTask object).

actualOwnerstring

preferredUsername of the user who claimed the task. Null if not claimed.

actualOwnerUserIdstring

Stable userId (subject) of actualOwner, looked up in the 'user' collection by preferredUsername. Null until claimed or if the user has no master record yet.

actualOwnerDisplayNamestring

"Lastname, Firstname" of actualOwner, looked up the same way as actualOwnerUserId.

adminGroupsarray

Groups with admin rights on the task.

Show child attributes

adminUsersarray

Users with admin rights on the task.

Show child attributes

excludedUsersarray

Users who must not see or work on the task (e.g. four-eyes principle).

Show child attributes

potentialGroupsarray

Groups allowed to claim the task.

Show child attributes

potentialUsersarray

Users allowed to claim the task.

Show child attributes

potentialUserIdsarray

Stable userIds (subject), one per entry in potentialUsers, looked up in the 'user' collection by preferredUsername. Null entries where no master record exists yet.

Show child attributes

potentialUserDisplayNamesarray

"Lastname, Firstname", one per entry in potentialUsers, looked up the same way as potentialUserIds.

Show child attributes

processIdstring

processId of the process the task belongs to.

processInstanceIdstring

processInstanceId of the process the task belongs to.

rootProcessIdstring

processId of the root process.

rootProcessInstanceIdstring

processInstanceId of the root process.

rootProcessInstanceallof

A process instance, a saved process draft or a process definition. Which fields are filled depends on the source: process lists are read from the MongoDB projection 'ecc_process_instances', single instances are additionally enriched with live data from the BPM engine, drafts come from 'ecc_saved' (state SAVED, processInstanceId prefixed 'tmp.') and process definitions only carry processId, processName and version.

Show child attributes

inputsstring

Task input data. Structure depends on the process model. GET /api/v1/task/{taskId} returns it as JSON object; list endpoints may return it as JSON string.

outputsstring

Task output data. Structure depends on the process model. Same format rules as inputs.

metadataobject

Engine metadata such as ProcessType, Lifecycle, skippable, NodeInstanceId.

userTaskstring

Full raw userTask snapshot from the latest USER_TASK_STATE/USER_TASK_ASSIGNMENT event in 'ecc_process_history' (processObject=tasks only) — everything the typed fields above already surface, plus anything not individually mapped.

eccUiPagestring
eccUiDirectorystring
401
Object

Missing, invalid or expired access token.

Response Attributes

successboolean

true for 2xx responses, false for errors.

httpStatusinteger

HTTP status code, same as the response status.

httpStatusReasonPhrasestring

HTTP reason phrase.

messageCodestring

Message code for application errors with a defined code (EccException), e.g. EAP0001.

messagestring

Message text. Localized for coded application errors, otherwise the technical exception message.

dataTypestring

Simple class name of the error or its data (errors only).

datastring

Payload. Type depends on the endpoint. For coded application errors the EccException.

403
Object

Not Allowed

500
Object

Error, e.g. the token has no groups claim or scope is unknown.

Response Attributes

successboolean

true for 2xx responses, false for errors.

httpStatusinteger

HTTP status code, same as the response status.

httpStatusReasonPhrasestring

HTTP reason phrase.

messageCodestring

Message code for application errors with a defined code (EccException), e.g. EAP0001.

messagestring

Message text. Localized for coded application errors, otherwise the technical exception message.

dataTypestring

Simple class name of the error or its data (errors only).

datastring

Payload. Type depends on the endpoint. For coded application errors the EccException.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?