Theme switcher

List log entries

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

filterSeverityarray

Severity to include, repeatable: DEBUG, INFO, WARN, ERROR, FATAL.

filterTypearray

Type to include, repeatable: PROCESS, ADAPTER, TASK, SYSTEM, AUTH, CONFIG.

filterSystemarray

System to include, e.g. core or api. Repeatable. Get the existing values from GET /api/v1/log/values/system.

Response

200
Object

Log entries, newest first.

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

Id of the log entry.

createdAtallof

Time the entry was written.

Show child attributes

userallof

Reference to a user.

Show child attributes

processInstanceIdstring

Related process instance, if any.

rootProcessInstanceIdstring

Related root process instance, if any.

actionstring

What was done: NONE, SAVE, LOAD, DELETE, EDIT, QUERY, START, COMPLETE, CLAIM, ...

Enum values:
NONESAVELOADDELETEEDITQUERYSTARTCOMPLETECLAIMUNCLAIM
... 16 other enums
taskIdstring

Related task, if any.

callSourcestring

ui if the request came from eccatm-ui (header ecc-source: eccatm-ui), otherwise api.

systemstring

Subsystem that wrote the entry. core for the business service, api for external callers.

severitystring

DEBUG, INFO, WARN, ERROR, FATAL.

Enum values:
DEBUGINFOWARNERRORFATAL
typestring

PROCESS, ADAPTER, TASK, SYSTEM, AUTH, CONFIG.

Enum values:
PROCESSADAPTERTASKSYSTEMAUTHCONFIG
stacktracestring

Stack trace for errors.

httpStatusinteger

HTTP status of the request.

durationinteger

Time since the request entered the service, in ms.

relatedTostring

Free reference.

adminInfostring

Additional information for administrators.

messagestring

Log message.

paramsarray

Message parameters.

Show child attributes

datastring

Payload related to the entry, e.g. the started process.

Show child attributes

eccVersionstring
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

Unexpected error, e.g. the BPM engine or MongoDB is not reachable. The message contains the cause.

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?