Event Records

An EventRecord is a durable event emitted by Files.com for routing through Event Channels.

List Event Records

SDK Function

EventRecord.list()

Return Object

ListIterator<EventRecord>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.EventRecord;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<EventRecord> eventRecords = EventRecord.list(parameters);
  for (EventRecord eventRecord : eventRecords.listAutoPaging()) {
    // Operate on eventRecord
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Show Event Record

SDK Function

EventRecord.find()

Return Object

EventRecord

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Function Arguments

ArgumentDescription
id
int64
Required
Event Record ID.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.EventRecord;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  EventRecord eventRecord = EventRecord.find(id, parameters);
  // Operate on eventRecord
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The EventRecord Object

Some of the functions above return a EventRecord object. The attributes of this object are listed below.

AttributeDescription
id
int64
Event Record ID
workspace_id
int64
Workspace ID. 0 means the default workspace or site-wide.
event_uuid
string
Stable event UUID.
event_type
string
Versioned event type string.
severity
string
Event severity.
Possible values: info, warning, error, critical
source_type
string
Source record type.
source_id
int64
Source record ID.
occurred_at
date-time
Event occurrence date/time.
human_title
string
Human-readable event title.
human_summary
string
Human-readable event summary.
human_fields
array(object)
Human-readable event detail fields.
actor
object
Actor associated with the event.
resources
array(object)
Resources associated with the event.
payload
object
Event payload.
created_at
date-time
Event Record create date/time.