WoodWing Assets 6 icon

WoodWing Assets 6

Interact with WoodWing Assets Server 6 API

Asset → Download as ZIP

AI-generated

Summary

Download multiple assets from WoodWing Assets Server 6 as a single compressed ZIP file with selectable source and format options.

Inputs

  • Authentication Method (required) — Choose between logging in automatically before download or using a previously obtained authentication token.
  • Auth Token (required) — The authentication token to authorize the download. Required if using the 'Use Token From Previous Login' method.
  • ZIP Filename (required) — The name for the downloaded ZIP file, e.g., 'assets.zip'.
  • Source Selection (required) — Method to select which assets to include in the ZIP: by comma-separated asset IDs, search query, or folder path.
  • Asset IDs (required) — Comma-separated list of asset IDs to download (required if Source Selection is 'Asset IDs').
  • Query String (required) — Search query string to select assets for download (required if Source Selection is 'Query').
  • Folder Path (required) — Folder path to download assets from (required if Source Selection is 'Folder Path').
  • Format Selection (required) — Choose file format to include in the ZIP: original files, preview files, download preset, or custom preview format.
  • Download Preset ID (required) — ID of the download preset to use for format conversion (required if Format Selection is 'Download Preset').
  • Preview Format (required) — Custom preview format specification (required if Format Selection is 'Custom Preview Format').
  • Optional Parameters — Additional optional settings such as maximum number of assets (for query or folder sources), ZIP compression level (0–9), and whether to stream the ZIP response directly or create a temporary file.

Output shape

a single item with binary data representing the ZIP file, along with JSON metadata about the filename, size, and MIME type

The output includes the ZIP file as binary data in the 'data' property keyed by the ZIP filename; JSON metadata includes the filename, file size in bytes, and MIME type 'application/zip'. If enabled, binary data from input can be passed through to the output. Errors during operation throw exceptions unless 'Continue On Fail' is set.

Examples

Example 1: Download a ZIP named 'my-assets.zip' containing original format files specified by asset IDs, authenticating by automatic login.

Authentication Method: Login and Download; ZIP Filename: my-assets.zip; Source Selection: Asset IDs with the IDs specified; Format Selection: Original Files.

Discussion