ecceene Automation v2 API Reference
REST API of the ecceene Automation v2 business service (eccatm-service). All endpoints require a Keycloak access token (Authorization: Bearer …). Every response uses the envelope EccApiResponse with the payload in data. Send Accept-Language for localized messages and ecc-source: eccatm-ui for calls from the eccatm user interface.
Further documentation
Topic | Page |
fields of every object | |
how the business service works | |
building pages that call the API |
Response envelope
Every response - success or error - is wrapped in the same envelope. The endpoint pages and their examples show only the content of data (errors: the error fields). The complete response looks like this:
{
"success": true,
"language": "en",
"timestamp": "2026-09-30 09:15:02Z",
"httpStatus": 200,
"httpStatusReasonPhrase": "OK",
"array": true,
"arrayCount": 2,
"data": [ ... ],
"tenant": "your-realm"
}
Field | Content |
| true for 2xx responses, false for errors. |
| 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. |
| Language of the response, taken from the first Accept-Language entry. Default: en. |
| UTC time of the response, format yyyy-MM-dd HH:mm:ssZ. |
| HTTP status code, same as the response status. |
| HTTP reason phrase. |
| true if data is a list. |
| Number of list entries in data. |
| Payload. Type depends on the endpoint. For coded application errors the EccException. |
| Simple class name of the error or its data (errors only). |
| Tenant of the user (Keycloak realm). Missing on 401 responses. |
On this page
- ecceene Automation v2 API Reference