Event Records

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

List Event Records

SDK Method

eventrecord.List()

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.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_record "github.com/Files-com/files-sdk-go/v3/eventrecord"
)

eventRecordIterator, err := event_record.List(files_sdk.EventRecordListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for eventRecordIterator.Next() {
    eventRecord := eventRecordIterator.eventRecord()
}
err = eventRecordIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Show Event Record

SDK Method

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.

EventRecordFindParams Fields

FieldDescription
Id
int64
Required
Event Record ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_record "github.com/Files-com/files-sdk-go/v3/eventrecord"
)

eventRecord, err := event_record.Find(files_sdk.EventRecordFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

The EventRecord Object

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

AttributeDescription
Id
int64
Event Record ID
WorkspaceId
int64
Workspace ID. 0 means the default workspace or site-wide.
EventUuid
string
Stable event UUID.
EventType
string
Versioned event type string.
Severity
string
Event severity.
Possible values: info, warning, error, critical
SourceType
string
Source record type.
SourceId
int64
Source record ID.
OccurredAt
date-time
Event occurrence date/time.
HumanTitle
string
Human-readable event title.
HumanSummary
string
Human-readable event summary.
HumanFields
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.
CreatedAt
date-time
Event Record create date/time.