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

pending_work_event.List()

Return Values

Returns a *pending_work_event.Iter and an error. Range over All() to receive files_sdk.PendingWorkEvent 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.

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

for pendingWorkEvent, err := range pendingWorkEventIterator.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(pendingWorkEvent)
}

Show Pending Work Event

SDK Method

pending_work_event.Find()

Return Values

Returns a files_sdk.PendingWorkEvent value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

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

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.