LogOperation

Manage log operations, which represent tracked actions performed by users or the system.
You can search for log operations with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/log-operation/index

Returns a paginated and filterable list of log operations.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching log operations

object

filter

object

log_operation_id

ID of the log operation

string

timestamp

Timestamp when the operation occurred

string

user_id

ID of the user who performed the operation

string

entity_id

ID of the entity involved in the operation

string

entity_type

Type of the entity involved (e.g., USER, SYSTEM)

string

entity_name

Name of the entity involved in the operation

string

method

HTTP method used for the operation (e.g., GET, POST)

string

data

Additional data related to the operation

string

nullable

subtenant_id

Subtenant ID related to the operation

string

tenant_id

Tenant ID to which the operation belongs

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "user_id": "user-1",
    "entity_type": "USER"
  },
  "per-page": 10,
  "page": 1,
  "sort": "timestamp"
}

Responses

200

List of log operations

Array<object>

object

log_operation_id

ID of the log operation

string

timestamp

Timestamp when the operation occurred

string

user_id

ID of the user who performed the operation

string

entity_id

ID of the entity involved in the operation

string

entity_type

Type of the entity involved (e.g., USER, SYSTEM)

string

entity_name

Name of the entity involved in the operation

string

method

HTTP method used for the operation (e.g., GET, POST)

string

data

Additional data related to the operation

string

nullable

subtenant_id

Subtenant ID related to the operation

string

tenant_id

Tenant ID to which the operation belongs

string

Example

{
  "log_operation_id": "logop-1",
  "timestamp": "2024-01-01T10:00:00Z",
  "user_id": "user-1",
  "entity_id": "ent-1",
  "entity_type": "USER",
  "entity_name": "John Doe",
  "method": "POST",
  "data": "Created new user",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/log-operation/view/{id}

Retrieve a log operation by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the log operation to retrieve

Responses

200

Log operation found

object

log_operation_id

ID of the log operation

string

timestamp

Timestamp when the operation occurred

string

user_id

ID of the user who performed the operation

string

entity_id

ID of the entity involved in the operation

string

entity_type

Type of the entity involved (e.g., USER, SYSTEM)

string

entity_name

Name of the entity involved in the operation

string

method

HTTP method used for the operation (e.g., GET, POST)

string

data

Additional data related to the operation

string

nullable

subtenant_id

Subtenant ID related to the operation

string

tenant_id

Tenant ID to which the operation belongs

string

Example

{
  "log_operation_id": "logop-1",
  "timestamp": "2024-01-01T10:00:00Z",
  "user_id": "user-1",
  "entity_id": "ent-1",
  "entity_type": "USER",
  "entity_name": "John Doe",
  "method": "POST",
  "data": "Created new user",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

404

Log operation not found