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

files_sdk.pending_work_event.list()

Return Object

ListObj[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 files_sdk

try:
  pending_work_events = files_sdk.pending_work_event.list()
  for pending_work_event in pending_work_events.auto_paging_iter():
    # Operate on pending_work_event
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Pending Work Event

SDK Method

files_sdk.pending_work_event.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.

Method Arguments

ArgumentDescription
id
int64
Required		Pending Work Event ID.

Example Request

import files_sdk

try:
  pending_work_event = files_sdk.pending_work_event.find(id)
  # Operate on pending_work_event
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

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
event_type
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.
event_errors
array(string)		Event errors.
created_at
date-time		Event create date/time.
body_url
string		Link to log file.
folder_behavior_id
int64		Folder Behavior ID.