Search audit events.

GET

/api/workspace/admin/audit/events

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/admin/audit/events?includeSystem=false&page=1&pageSize=50"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/audit/events?includeSystem=false&page=1&pageSize=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/workspace/admin/audit/events?includeSystem=false&page=1&pageSize=50' \
  --header 'Authorization: Bearer <token>'

Requires the Admin role. Returns the newest events first. Record archive, restore and permanent delete events carry the operation’s reason as the audit.data.reason data item and name records by type and ID only, never by field values; they remain after a record is permanently deleted. To find them for one record, pass objectType=MoltaroEntityInstance and its objectId; for one record type, pass objectType=EntityDefinition and the definition ID. Both object parameters are required to filter. Record rights still apply: for an existing record the caller may not read, the record is named by type and ID only and the details of events about it (such as a reason, comment text or file names) are removed. For a readable record, a stored name is shown only when it matches the name the caller sees from readable fields, comment text needs Comments:View, file names need Attachments:View on a record the event names, a File field file needs Field:Read on the field holding it and on its table field, and a lifecycle reason needs ReadChangesHistory. Each named file is also judged by its stored owner, even when the event names no record. When the stored file no longer determines its owner, a record the event names must allow reading all its files (attachments and every File field); with no owner named either, the file name is hidden. Such events have RecordDataHidden set to true.

Authorizations

WorkspaceBearer

Parameters

Query Parameters

userIds

Array<string>

Acting user IDs; repeat the parameter for several users.

includeSystem

boolean

Include events performed by the system actor. With no user IDs, returns only system events.

classifierIds

Array<string>

Audit classifier IDs; each also matches its child classifiers. Repeat the parameter for several classifiers.

objectType

string

Type of an object the event names, such as MoltaroEntityInstance or EntityDefinition.

objectId

string

ID of that object; used only together with objectType.

startDate

string format: date

First date to include, in the workspace time zone.

endDate

string format: date

Last date to include (inclusive), in the workspace time zone.

page

integer format: int32

default: 1

One-based page number; values below 1 are treated as 1.

pageSize

integer format: int32

default: 50

Items per page. The default is 50; zero or negative values use the default and values above 200 are capped.

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

application/json

object

Data

Paged audit events list.

object

Items

Audit events.

Array<object>

nullable

Audit event display model.

object

Audit event id.

string

nullable

OccurredAt

Timestamp of the event (UTC).

string format: date-time

Actor

Actor metadata for an audit event.

object

User identifier, if any.

string

nullable

Name

Display name.

string

nullable

Email

Email address when available.

string

nullable

IsSystem

True for system actions.

boolean

Classifier

Classifier details for an audit event.

object

Classifier id.

string

nullable

Code

Classifier code.

string

nullable

Name

Display name.

string

nullable

Path

Display path for the hierarchy.

string

nullable

Type

Rendering type for the UI.

string

nullable

Subject

Short localized subject.

string

nullable

Text

Optional localized description.

string

nullable

PrimaryObject

Object reference linked to an audit event.

object

ObjectType

Domain object type.

string

nullable

ObjectId

Domain object identifier.

string

nullable

ObjectName

Display name/title.

string

nullable

Role

integer format: int32

Allowed values: 0 1

AffectedObjects

Affected object references.

Array<object>

nullable

Object reference linked to an audit event.

object

ObjectType

Domain object type.

string

nullable

ObjectId

Domain object identifier.

string

nullable

ObjectName

Display name/title.

string

nullable

Role

integer format: int32

Allowed values: 0 1

DataItems

Additional data entries.

Array<object>

nullable

Key/value payload entry for audit UI.

object

LabelKey

Localization key for the label.

string

nullable

Value

Raw display value.

string

nullable

ValueKey

Optional localization key for the value.

string

nullable

RecordDataHidden

True when record names or event details were hidden because the reader lacks access to an existing record the event names or whose file it names, or to the fields, comments, files or change history the hidden details came from, or because the owner of a named file can no longer be determined. Hidden record names show the record type and ID only.

boolean

TotalCount

Total matching events.

integer format: int32

Page

Current page.

integer format: int32

PageSize

Page size.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Items": [
      {
        "PrimaryObject": {
          "Role": 0
        },
        "AffectedObjects": [
          {
            "Role": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Paged audit events list.

object

Items

Audit events.

Array<object>

nullable

Audit event display model.

object

Audit event id.

string

nullable

OccurredAt

Timestamp of the event (UTC).

string format: date-time

Actor

Actor metadata for an audit event.

object

User identifier, if any.

string

nullable

Name

Display name.

string

nullable

Email

Email address when available.

string

nullable

IsSystem

True for system actions.

boolean

Classifier

Classifier details for an audit event.

object

Classifier id.

string

nullable

Code

Classifier code.

string

nullable

Name

Display name.

string

nullable

Path

Display path for the hierarchy.

string

nullable

Type

Rendering type for the UI.

string

nullable

Subject

Short localized subject.

string

nullable

Text

Optional localized description.

string

nullable

PrimaryObject

Object reference linked to an audit event.

object

ObjectType

Domain object type.

string

nullable

ObjectId

Domain object identifier.

string

nullable

ObjectName

Display name/title.

string

nullable

Role

integer format: int32

Allowed values: 0 1

AffectedObjects

Affected object references.

Array<object>

nullable

Object reference linked to an audit event.

object

ObjectType

Domain object type.

string

nullable

ObjectId

Domain object identifier.

string

nullable

ObjectName

Display name/title.

string

nullable

Role

integer format: int32

Allowed values: 0 1

DataItems

Additional data entries.

Array<object>

nullable

Key/value payload entry for audit UI.

object

LabelKey

Localization key for the label.

string

nullable

Value

Raw display value.

string

nullable

ValueKey

Optional localization key for the value.

string

nullable

RecordDataHidden

boolean

TotalCount

Total matching events.

integer format: int32

Page

Current page.

integer format: int32

PageSize

Page size.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Items": [
      {
        "PrimaryObject": {
          "Role": 0
        },
        "AffectedObjects": [
          {
            "Role": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Search audit events.

Authorizations

Parameters

Query Parameters

Responses

200

Example

400

Example

403

Examplegenerated

Example^generated