Pending Work Events

A PendingWorkEvent is a log record for pending file work failures, such as GPG Encryption and GPG Decryption.

List Pending Work Events

SDK Method

pendingworkevent.List()

Return Object

[]*PendingWorkEvent

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"
    pending_work_event "github.com/Files-com/files-sdk-go/v3/pendingworkevent"
)

pendingWorkEventIterator, err := pending_work_event.List(files_sdk.PendingWorkEventListParams{})
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 pendingWorkEventIterator.Next() {
    pendingWorkEvent := pendingWorkEventIterator.pendingWorkEvent()
}
err = pendingWorkEventIterator.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 Pending Work Event

SDK Method

pendingworkevent.Find()

Return Object

PendingWorkEvent

Authorization Requirement

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

PendingWorkEventFindParams Fields

FieldDescription
Id
int64
Required		Pending Work Event ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    pending_work_event "github.com/Files-com/files-sdk-go/v3/pendingworkevent"
)

pendingWorkEvent, err := pending_work_event.Find(files_sdk.PendingWorkEventFindParams{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 PendingWorkEvent Object

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

AttributeDescription
Id
int64		Event ID
EventType
string		Type of pending work event being recorded.
Status
string		Status of event.
Possible values: success, failure, partial_failure, in_progress, skipped
Body
string		Event body.
EventErrors
array(string)		Event errors.
CreatedAt
date-time		Event create date/time.
BodyUrl
string		Link to log file.
FolderBehaviorId
int64		Folder Behavior ID.