Report a user event
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)
Body Parameters
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.
Event source: ui, api, system, process, user.
Event name, e.g. login, logout, view, create.
Scope: global, tenant, user.
Message id of the event text.
Parameters of the message.
Show child attributes
Resolved message (read only).
Show child attributes
Related process.
Related task.
Response
The received event.
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.
Event source: ui, api, system, process, user.
Event name, e.g. login, logout, view, create.
Scope: global, tenant, user.
Message id of the event text.
Parameters of the message.
Show child attributes
Resolved message (read only).
Show child attributes
Related process.
Related task.
Bad Request
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.
Not Allowed
Response