Execute a task action
Header Parameters
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)
Path Parameters
Id of the task.
claim: take the taskrelease: give the task back to its groupscomplete: complete the task
claimreleasecompleteResponse
The task after the action.
Response Attributes
Technical MongoDB document id. Not a business identifier - do not use it to address objects.
Object type, e.g. process, task, history, process_history, process_node, event.
Java class name of the object.
Unique id of the task instance.
Task description from the BPMN model.
Task name from the BPMN model. Also used to find the task page in the frontend.
Task priority.
Lifecycle state: Ready, Reserved, InProgress, Completed, Skipped, Obsolete, Error.
Suggested icon key, derived from state (processObject=tasks only), e.g. userTask-ready, userTask-reserved.
Creation time of the task.
Completion time.
Time of the last change.
Due date, if defined.
Reference name of the task node in the BPMN model.
External reference id, if set by the engine.
REST endpoint of the task in the BPM engine.
nodeInstanceId of the userTask node this task belongs to (from the BPM engine's process history).
Comment/subject configured for the task node in the BPMN model (from workItem.input, not the userTask object).
Content/body configured for the task node in the BPMN model (from workItem.input, not the userTask object).
Group id the task was created for (from workItem.input, not the userTask object).
preferredUsername of the user who claimed the task. Null if not claimed.
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.
"Lastname, Firstname" of actualOwner, looked up the same way as actualOwnerUserId.
Groups with admin rights on the task.
Show child attributes
Users with admin rights on the task.
Show child attributes
Users who must not see or work on the task (e.g. four-eyes principle).
Show child attributes
Groups allowed to claim the task.
Show child attributes
Users allowed to claim the task.
Show child attributes
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
"Lastname, Firstname", one per entry in potentialUsers, looked up the same way as potentialUserIds.
Show child attributes
processId of the process the task belongs to.
processInstanceId of the process the task belongs to.
processId of the root process.
processInstanceId of the root process.
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
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.
Show child attributes
Task output data. Structure depends on the process model. Same format rules as inputs.
Engine metadata such as ProcessType, Lifecycle, skippable, NodeInstanceId.
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.
Unknown actionId.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Missing, invalid or expired access token.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
The user may not execute the action (task owned by someone else or not owned by the user).
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Task not found.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Unexpected error, e.g. the BPM engine or MongoDB is not reachable. The message contains the cause.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Response