a2 | API Reference

## Sections
• [ecceene Automation v2 API Reference](https://doc.ecceene.com/a2-api-reference/ecceene-automation-v2-api-reference.md): REST API of the ecceene Automation v2 business service (eccatm-service). All endpoints require a Keycloak access token (Authorization: Bearer …).…
• [Admin](https://doc.ecceene.com/a2-api-reference/admin.md): Administrative functions.
  • [Reload a cache](https://doc.ecceene.com/a2-api-reference/admin/reload-a-cache.md): Reloads an in-memory cache without restart. Supported cacheId: i18n (message texts from the classpath files and from the database). data contains one…
• [User](https://doc.ecceene.com/a2-api-reference/user.md): The logged-in user and user events.
  • [Report a user event](https://doc.ecceene.com/a2-api-reference/user/report-a-user-event.md): Accepts a user event from the frontend (e.g. login, logout) and returns it unchanged. Returned object: EccEvent .
  • [Get the current user](https://doc.ecceene.com/a2-api-reference/user/get-the-current-user.md): Returns the user of the access token: names, e-mail, tenant, realm and client roles and groups. The first call of a user also creates the user master…
• [Log](https://doc.ecceene.com/a2-api-reference/log.md): Application log of the business service.
  • [List log entries](https://doc.ecceene.com/a2-api-reference/log/list-log-entries.md): Returns the entries of the application log (‘ecc_history’), newest first. The service writes an entry for every process start, draft save or delete…
  • [List distinct values of a log field](https://doc.ecceene.com/a2-api-reference/log/list-distinct-values-of-a-log-field.md): Returns the distinct values of a field in the application log, e.g. to fill filter drop-downs. Typical fields: system, severity, type, action,…
• [Processes](https://doc.ecceene.com/a2-api-reference/processes.md): Process instances and saved drafts.
  • [Save a process draft](https://doc.ecceene.com/a2-api-reference/processes/save-a-process-draft.md): Saves process data without starting the process, e.g. to continue later. Without processInstanceId a new draft is created with the id tmp.{uuid};…
  • [List process instances or drafts](https://doc.ecceene.com/a2-api-reference/processes/list-process-instances-or-drafts.md): Without parameters: all root process instances (no parent) from the MongoDB projection ‘ecc process instances’, optionally filtered by processId.…
  • [Count open processes](https://doc.ecceene.com/a2-api-reference/processes/count-open-processes.md): Counts the root process instances in the MongoDB projection by state, in total and per process (appCount). Overdue instances (slaDueDate in the past)…
  • [Start a process](https://doc.ecceene.com/a2-api-reference/processes/start-a-process.md): Starts a new instance of the process definition processId. The body is the start data exactly as the process expects it (use GET…
  • [Get a process instance](https://doc.ecceene.com/a2-api-reference/processes/get-a-process-instance.md): Returns a process instance. The id is resolved in this order: processInstanceId in the MongoDB projection, business key in the projection, saved…
  • [Delete a saved draft](https://doc.ecceene.com/a2-api-reference/processes/delete-a-saved-draft.md): Deletes a draft of the current user from ‘ecc_saved’. Running process instances cannot be deleted with this endpoint. Returned object: EccProcess .
  • [Get related objects of a process instance](https://doc.ecceene.com/a2-api-reference/processes/get-related-objects-of-a-process-instance.md): Returns objects that belong to a root process instance. processObject selects the result: history : the history of the case - the root instance and…
• [Schema](https://doc.ecceene.com/a2-api-reference/schema.md): Process definitions and their data structures.
  • [List process definitions](https://doc.ecceene.com/a2-api-reference/schema/list-process-definitions.md): Returns all process definitions deployed in the BPM engine with processId, processName and version. Use processId to start a process and processId +…
  • [Get the data structure of a node](https://doc.ecceene.com/a2-api-reference/schema/get-the-data-structure-of-a-node.md): Returns the input and output structure of a single node (user task, service task, sub-process, …) as JSON templates with empty example values. input…
  • [Get process structure data](https://doc.ecceene.com/a2-api-reference/schema/get-process-structure-data.md): Returns structural information of a process definition. type selects the result: data : JSON template of the start data, built from the BPMN start…
• [Tasks](https://doc.ecceene.com/a2-api-reference/tasks.md): User tasks of the logged-in user.
  • [List tasks of the current user](https://doc.ecceene.com/a2-api-reference/tasks/list-tasks-of-the-current-user.md): Returns the open tasks the current user can see, based on the groups claim of the token. Each task is enriched with its root process instance…
  • [Get a task](https://doc.ecceene.com/a2-api-reference/tasks/get-a-task.md): Returns a single task including parsed inputs and outputs. Access rules: the owner always gets the task; if another user owns the task, the answer is…
  • [Execute a task action](https://doc.ecceene.com/a2-api-reference/tasks/execute-a-task-action.md): Changes the lifecycle state of a user task on behalf of the current user and returns the updated task. actionId selects the action: claim : assigns…