Bundle Actions

A BundleAction is an action performed on a bundle. Provides detailed information about the action's type, involved paths and other information.

List Bundle Actions

SDK Method

\Files\Model\BundleAction::list;

Return Object

BundleAction[]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
bundle_id
int64		Bundle ID
bundle_registration_id
int64		Bundle Registration ID

Additional Arguments

Example Request

try {
  $bundle_actions = \Files\Model\BundleAction::list([
    'user_id' => 1
  ]);
  foreach ($bundle_actions as $bundle_action) {
    // Operate on $bundle_action
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The BundleAction Object

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

AttributeDescription
action
string		Type of action
Possible values: create, read, update, destroy, move, copy, registration
bundle_registration
BundleRegistration		Object that contains bundle registration information
created_at
date-time		Action occurrence date/time
destination
string		The destination path for this bundle action, if applicable
path
string		Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
source
string		The source path for this bundle action, if applicable
bundle_registration_id
int64		Identifier of the associated bundle registration
workspace_id
int64		Workspace ID. 0 means the default workspace.
bundle_registration_name
string		Name of the registrant who performed the action
bundle_registration_email
string		Email of the registrant
bundle_registration_ip
string		IP address of the registrant
form_field_set_id
int64		Id of associated form field set
form_field_data
object		Data for form field set with form field ids as keys and user data as values