Bundle Downloads

A BundleDownload is a record of the download action that happened in the bundle.

SDK Method

files_sdk.bundle_download.list()

Return Object

ListObj[BundleDownload]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
bundle_id
int64
Bundle ID
bundle_registration_id
int64
BundleRegistration ID

Additional Arguments

Example Request

import files_sdk

try:
  bundle_downloads = files_sdk.bundle_download.list({
    "bundle_id": 1
  })
  for bundle_download in bundle_downloads.auto_paging_iter():
    # Operate on bundle_download
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 BundleDownload Object

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

AttributeDescription
bundle_registration
BundleRegistration
download_method
string
Download method (file or full_zip)
Possible values: file, full_zip
path
string
Download path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
workspace_id
int64
Workspace ID. 0 means the default workspace.
created_at
date-time
Download date/time