Event Records

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

List Event Records

SDK Method

event_record.List()

Return Values

Returns a *event_record.Iter and an error. Range over All() to receive files_sdk.EventRecord values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

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.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for eventRecord, err := range eventRecordIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(eventRecord)
}

Show Event Record

SDK Method

event_record.Find()

Return Values

Returns a files_sdk.EventRecord value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

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.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(eventRecord)

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. Valid values: automation_run.canceled.v1, automation_run.failure.v1, automation_run.failure_will_retry.v1, automation_run.partial_failure.v1, automation_run.partial_failure_will_retry.v1, automation_run.skipped.v1, automation_run.success.v1, expectation_evaluation.invalid.v1, expectation_evaluation.late.v1, expectation_evaluation.missing.v1, expectation_evaluation.success.v1, expectation_incident.acknowledged.v1, expectation_incident.open.v1, expectation_incident.resolved.v1, expectation_incident.snoozed.v1, external_event.client_log.failure.v1, external_event.client_log.partial_failure.v1, external_event.client_log.skipped.v1, external_event.client_log.success.v1, pending_work_event.failure.v1, pending_work_event.partial_failure.v1, pending_work_event.skipped.v1, pending_work_event.success.v1, siem_http_destination_event.failure.v1, siem_http_destination_event.partial_failure.v1, siem_http_destination_event.skipped.v1, siem_http_destination_event.success.v1, sso_event.ldap_login.failure.v1, sso_event.ldap_login.partial_failure.v1, sso_event.ldap_login.skipped.v1, sso_event.ldap_login.success.v1, sso_event.ldap_sync.failure.v1, sso_event.ldap_sync.partial_failure.v1, sso_event.ldap_sync.skipped.v1, sso_event.ldap_sync.success.v1, sso_event.saml_login.failure.v1, sso_event.saml_login.partial_failure.v1, sso_event.saml_login.skipped.v1, sso_event.saml_login.success.v1, sync_run.failure.v1, sync_run.partial_failure.v1, sync_run.skipped.v1, sync_run.success.v1, user_security_event.lockout.v1
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.