Core - System

Module dedicated to all the system actions.

The base url for the APIs in this page is at:

/api/admin

A JSON file with OpenAPI data about all core-related admin APIs can be downloaded here.

Reindex

Reindexes all the core entities:

POST /v1/system/reindex

Reindexes all the core entities

Status Codes

Returns a plain Json positive response if the request was successful.

Retrieve Action Logs

Gets the list of the logged activities for end users and operators (it’s a Paged List APIs, as explained in the introduction):

GET /v1/logs/list

Gets the list of logs

Query Parameters

  • performingUser (string) – The user that performed the action

  • performedAction (string) – A concatenated string for the list of actions

  • involvedEntity (string) – A concatenated string for the list of entities to search for

  • entityType (string) – A concatenated string for the list of entities

  • from (string) – From… creation DateTime

  • to (string) – To… creation DateTime

Status Codes

The following filter can be specified in the query params:

  • performingUser: a string with the name, or part of it, of the user who performed the action

  • performedAction: the list of action codes divided by comma

  • involvedEntity: a string to be searched inside the identifier of the involved entity or its specific data

  • entityType: the list of entity codes divided by a comma

  • from: a date representing the lower bound for the date in which the action was performed

  • to: a date representing the upper bound for the date in which the action was performed

The values accepted in the performedAction and entityType filters are specified, respectivly, in the LogActionType and LogEntityType enums.

the response will be a list of the action logs filtered according to the provided filters (if no filter is set, the API will return the full list):

[
  {
    Id: "0a5342ee-70b4-4f44-98e2-011cd2330d55",              // Guid
    ActionType: 1,                                           // LogActionType enum
    PerformingUser: "Administrator",                         // String
    PerformingGuid: "df14c292-b7c2-464d-af2a-e69291cbbc13",  // Performing user Guid
    CreatedDate: "1970-01-01T00:00:00Z",                     // Date
    IpAddress: "127.0.0.1",                                  // String
    EntityType: 101,                                         // LogEntityType enum
    EntityName: "john.doe@gmail.com",                        // String
    EntityGuid: "42",                                        // String, Guid or ID of the involved entity
    Data: [
      {
        Key: "LicensePlate",                                 // String
        Value: "AB 123 CD"                                   // String
      },
      ...
    ]
  },
  ...
]

or one of the following errors:

err_InvalidDate

The value specified for from date, to date or both is not a valid date format