woodwing-assets-6

Open-source n8n connector for WoodWing Assets Server v6 with a transparent Fair-Use model by 3f8h.net / electronic publishing.

Package Information

Downloads: 51 weekly / 69 monthly
Latest Version: 1.2.1
Author: Sebastian Nafroth

Documentation

@3f8h/n8n-nodes-woodwing-assets-6

This is an n8n community node for integrating with WoodWing Assets Server 6.

n8n is a fair-code licensed workflow automation platform.

Fair-Use License

This node is provided under an MIT license and is free for reasonable use:

Free for Fair Use:

  • Personal projects and evaluation
  • Small business use (< 1000 assets/month)
  • Open source projects
  • No functionality restrictions
  • Full source code access

Commercial License Beyond Fair Use:

For commercial deployments exceeding fair use limits, obtain a license key at:
** 3f8h.net/n8n-assets**

How it works:

  1. The node works fully without a license key – no delays, no lockouts, no restrictions
  2. Enter your license key in the node configuration to remove fair-use notices
  3. That's it! You'll see "✅ LICENSED" in logs instead of "⚠️ FAIR-USE"

No tracking, no phone home, honor system – we trust the community.

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

WoodWing Assets 6 Node

  • Asset History: Retrieve versioning and history details for assets in WoodWing Assets Server 6
  • Create: Upload and create assets in WoodWing Assets Server 6, or create placeholder assets
  • Create Folder: Create one or more folders in the WoodWing Assets Server 6
  • Create or Update: Create new asset or update existing asset at the same location
  • Download: Download individual asset files (thumbnail, preview, or original)
  • Download as ZIP: Download multiple assets as a compressed ZIP file
  • Login: Authenticate with WoodWing Assets Server 6 and retrieve authToken
  • Search: Search for assets in the WoodWing Assets Server 6 with flexible query options
  • Update: Update existing assets in WoodWing Assets Server 6 (file, metadata, or both)

Credentials

This node requires the following credentials:

  • Server URL: The URL of your WoodWing Assets Server (e.g., http://yourserver.com)
  • Username: Your Assets Server username
  • Password: Your Assets Server password

Compatibility

  • WoodWing Assets Server: Version 6.x
  • n8n: Version 1.0.0 or higher
  • n8n Cloud: Compatible (no external dependencies required)

Usage

Global Debugging

All operations support a global Debug to Console parameter that logs detailed information to the n8n console for troubleshooting. When enabled, you will see:

  • Operation being executed
  • Authentication method used
  • Auth token (redacted for security, showing only first and last 8 characters)
  • Parameters and options configured
  • Request URLs (with tokens redacted)

This is useful for troubleshooting API issues or understanding what data is being sent to WoodWing Assets Server.

Enhanced Logging

All operations include enhanced logging for monitoring and troubleshooting:

Log Format:

  • Custom Prefix: [3f8h.net WoodWing Assets 6] - Easy identification in logs
  • ISO Timestamps: Precise timing in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)
  • License Status: ✅ LICENSED (with valid license key) or ⚠️ FAIR-USE (without license key)

What Gets Logged:

  • Operation start with execution context (operation type, item count)
  • Authentication success/failure with details (username, server version)
  • Asset operations with results (asset IDs, file counts, file sizes)
  • Fair-use notice once per execution (for unlicensed users only)
  • Operation completion confirmations

Example Logs (Unlicensed):

[2025-11-06T13:45:23.456Z] [3f8h.net WoodWing Assets 6] [⚠️ FAIR-USE] Starting "create" operation
[2025-11-06T13:45:23.457Z] [3f8h.net WoodWing Assets 6] [⚠️ FAIR-USE] Running in Fair-Use mode. Obtain license at https://3f8h.net/n8n-woodwing-assets
[2025-11-06T13:45:24.123Z] [3f8h.net WoodWing Assets 6] [⚠️ FAIR-USE] Asset created successfully

Example Logs (Licensed):

[2025-11-06T13:45:23.456Z] [3f8h.net WoodWing Assets 6] [✅ LICENSED] Starting "create" operation
[2025-11-06T13:45:24.123Z] [3f8h.net WoodWing Assets 6] [✅ LICENSED] Asset created successfully

Note: This enhanced logging is always active and provides operational visibility. It's separate from the Debug to Console option above, which adds additional technical details specifically for API troubleshooting (request URLs, parameters, auth tokens, etc.).

Login Operation

The login operation authenticates with your WoodWing Assets Server and returns:

  • authToken: JWT token for authenticated API requests
  • serverVersion: The version of your Assets Server

This authToken can be used in subsequent operations to make authenticated requests to other WoodWing Assets API endpoints.

Asset History Operation

The asset history operation retrieves versioning and history details for a specific asset in WoodWing Assets Server 6:

Authentication Methods:

  • Login and Get History: Log in automatically before retrieving asset history
  • Use Token from Previous Login: Use the token from a previous login for efficient workflows

Parameters:

  • Asset ID (required): The WoodWing Assets Server ID of the asset to retrieve history for (e.g., 5LMAQTW9qfhANn7f6JJVpl)

Optional Parameters:

  • Start: Starting offset for pagination (default: 0)
  • Number of Hits: Maximum number of history records to return
  • Detail Level: Predefined levels (0-5) controlling which actions are returned:
    • Level 0 - Custom: Use Actions parameter to specify custom actions (Actions field will appear below)
    • Level 1 - Basic Creation Events: CREATE, CREATE_VARIATION, COPY, COPY_VERSION, CHECKIN
    • Level 2 - Creation + File Operations: Level 1 + MOVE, RENAME
    • Level 3 - Most Events: All except CHECKOUT, UNDO_CHECKOUT, METADATA_UPDATE, PREVIEW, AUTHKEY_UPDATE
    • Level 4 - All Events (Exclude Preview): All except PREVIEW
    • Level 5 - All Events: All history events including PREVIEW
  • Actions: Comma-delimited list of specific actions to retrieve (e.g., CREATE,CHECKIN,METADATA_UPDATE). Only shown when Detail Level is set to Custom.

Available Actions:

  • Asset File Operations: CREATE, CREATE_VARIATION, COPY, COPY_VERSION, MOVE, RENAME, REMOVE
  • Metadata: METADATA_UPDATE
  • Checkout: CHECKIN, CHECKOUT, UNDO_CHECKOUT
  • Version: REMOVE_VERSION
  • Download: DOWNLOAD, PREVIEW, RENDITION
  • Other: AUTHKEY_UPDATE

Response:
Returns a JSON object with history information including:

  • usageStats: Array of usage statistics records with action details
  • Each record contains:
    • action: The action performed (e.g., CREATE, CHECKIN, METADATA_UPDATE)
    • user: User who performed the action
    • date: Timestamp of the action
    • changedMetadata: Object showing old and new values for metadata changes

Use Cases:

  • Audit trails: Track who modified an asset and when
  • Version tracking: Monitor asset lifecycle from creation to current state
  • Compliance: Document asset changes for regulatory requirements
  • Troubleshooting: Investigate unexpected asset modifications

Example Workflows:

Get complete asset history:

Asset History (login and get history)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Optional Parameters:
    - Detail Level: Level 5 - All Events

Track only creation and check-in events:

Asset History (login and get history)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Optional Parameters:
    - Detail Level: Level 1 - Basic Creation Events

Custom audit for specific actions:

Asset History (login and get history)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Optional Parameters:
    - Detail Level: Custom (Use Actions Parameter)
    - Actions: CREATE,METADATA_UPDATE,CHECKIN

Token reuse for multiple assets:

Login → Asset History (use token) → Asset History (use token) → Asset History (use token)

Create Operation

The create operation allows you to upload files and create assets in WoodWing Assets Server 6:

Authentication Methods:

  • Login and Create: Log in automatically before creating the asset
  • Use Token from Previous Login: Use the token from a previous login for efficient workflows

Parameters:

  • Create Placeholder (optional): Create a placeholder asset without uploading a file. The placeholder will be 0kb in size.
  • Binary Property (required when not creating placeholder): Name of the binary property that contains the file to upload (default: "data")
  • Folder Path (required): Folder path where the asset will be created (e.g., /Demo Zone/MyFolder)
  • Filename (required): Filename for the asset including extension (e.g., image.jpg)

Advanced Options:

  • Auto Rename: Whether to automatically rename the file if one with the same name already exists. If disabled, an error will be returned.
  • Metadata: A JSON encoded object with properties that match Assets Server metadata field names. This metadata will be set on the asset in Assets Server. Example: {"description": "My asset description", "keywords": "sample,test"}
  • Metadata to Return: Comma-separated list of metadata fields to return. Leave empty for minimal fields, use "all" for all fields.
  • Next URL: URL to redirect to after successful creation. Use ${ID} as placeholder for the asset ID.

Response:
Returns a JSON object with asset information including:

  • id: The asset ID
  • metadata: All metadata about the created asset
  • permissions: User permissions for the asset
  • thumbnailHits: Thumbnail information (for image/video files)
  • originalUrl: URL to access the original file

Example Workflows:

Upload a file:

Read Binary File → Create (login and create)
  - Binary Property: data
  - Folder Path: /Demo Zone/uploads
  - Filename: myfile.jpg
  - Auto Rename: true

Create placeholder collection:

Create (login and create)
  - Create Placeholder: true
  - Folder Path: /Demo Zone/Collections
  - Filename: My Collection.collection

Token reuse for multiple uploads:

Login → Create (use token) → Create (use token) → Create (use token)

Create or Update Operation

The create or update operation creates a new asset or updates an existing asset at the same location:

How It Works:

  1. Searches for an existing asset at the destination path (folder path + filename)
  2. If asset doesn't exist → creates new asset
  3. If asset exists → extracts the ID and updates the existing asset
  4. Returns the final asset information (from either create or update)

Authentication Methods:

  • Login and Create/Update: Log in automatically before the operation
  • Use Token from Previous Login: Use the token from a previous login for efficient workflows

Parameters:

  • Binary Property (required): Name of the binary property that contains the file to upload (default: "data")
  • Folder Path (required): Folder path where the asset will be created or updated (e.g., /Demo Zone/MyFolder)
  • Filename (required): Filename for the asset including extension (e.g., image.jpg)

Advanced Options:

  • Auto Rename: Automatically rename the file if one exists during creation (default: false). Only applies when creating new assets.
  • Clear Checkout State: Control checkout field clearing when updating (Not Set/True/False, default: Not Set). Only applies when updating existing assets.
  • Keep Metadata on Update: Maintain existing Assets metadata when updating (default: true). Only applies when updating existing assets.
  • Metadata: A JSON encoded object with properties that match Assets Server metadata field names. Example: {"description": "My asset", "keywords": "sample,test"}
  • Metadata to Return: Comma-separated list of metadata fields to return. Leave empty for minimal fields, use "all" for all fields.
  • Next URL: URL to redirect to after successful operation. Use ${ID} as placeholder for the asset ID.
  • Parse Metadata Modifications: Enable parsing of "+" and "-" characters in metadata values (default: true). Only applies when updating existing assets.

Response:
Returns a JSON object with asset information including:

  • id: The asset ID
  • metadata: All metadata about the asset
  • permissions: User permissions for the asset
  • thumbnailHits: Thumbnail information (for image/video files)
  • originalUrl: URL to access the original file

Use Cases:

  • Idempotent workflows - ensure an asset exists at a specific location with specific content
  • Content synchronization - sync assets from external systems without worrying about duplicates
  • Publishing pipelines - publish content that may be new or updated
  • Automated deployments - deploy assets that should overwrite if they exist

Example Workflows:

Sync file from external system:

HTTP Request (download file) → Create or Update
  - Folder Path: /Demo Zone/Imports
  - Filename: {{$json.filename}}
  - Binary Property: data
  - Advanced Options:
    - Keep Metadata on Update: true
    - Metadata: {"source": "External System", "sync_date": "{{$now}}"}

Publishing pipeline with version control:

Read Binary File → Create or Update
  - Folder Path: /Published/{{$json.category}}
  - Filename: {{$json.slug}}.jpg
  - Advanced Options:
    - Keep Metadata on Update: false (allow metadata refresh)
    - Metadata: {"version": "{{$json.version}}", "published": "true"}

Token reuse for batch operations:

Login → Create or Update (use token) → Create or Update (use token) → Create or Update (use token)

Debug Logging:
When debug logging is enabled, you'll see which path was taken:

  • "Asset not found - will CREATE" → New asset will be created
  • "Asset found - will UPDATE" → Existing asset will be updated

Download Operation

The download operation retrieves individual asset files (thumbnail, preview, or original) from WoodWing Assets Server 6:

How It Works:

  1. Performs a background search with query id:assetId to retrieve asset information and download URLs
  2. Extracts thumbnailUrl, previewUrl, and originalUrl from the search response
  3. Downloads each selected file type using the authentication header
  4. Automatically rewrites URLs using the /*/filename.ext pattern for custom filenames
  5. Returns n8n binary data for each file type as separate binary properties

Authentication Methods:

  • Login and Download: Log in automatically before downloading
  • Use Token from Previous Login: Use the token from a previous login for efficient workflows

Parameters:

  • Asset ID (required): The WoodWing Assets Server ID of the asset to download (e.g., 5LMAQTW9qfhANn7f6JJVpl)
  • Files to Download (required): Select which file types to download (can select multiple):
    • Thumbnail: Download thumbnail version
    • Preview: Download preview version
    • Original: Download original file version

Search Options Collection:

  • Log Search: Whether to log the background search on the server for analytics (default: false)
  • Metadata to Return: Comma-separated list of metadata fields to return in the response (e.g., description,keywords,rating)
  • Return Highlighted Text: Include search term highlights in the response (default: false)

Filename Options Collection:

  • Use Asset ID as Filename: Replace the original filename with the asset ID (default: false)
    • When true: Files will be named like 5LMAQTW9qfhANn7f6JJVpl_thumbnail.jpg
    • When false: Files will use original filename like myimage_thumbnail.jpg
  • Thumbnail Suffix: Suffix to append to thumbnail filenames (default: _thumbnail)
  • Preview Suffix: Suffix to append to preview filenames (default: _preview)
  • Original Suffix: Suffix to append to original filenames (default: _original)

Response:
Returns a JSON object with:

  • assetId: The asset ID that was downloaded
  • downloadedFiles: Array of file types that were successfully downloaded (e.g., ["thumbnail", "preview", "original"])
  • metadata: Asset metadata from the background search

Each downloaded file is returned as a separate binary property:

  • thumbnail: Thumbnail file binary data (if selected)
  • preview: Preview file binary data (if selected)
  • original: Original file binary data (if selected)

URL Rewriting:
The operation automatically rewrites WoodWing download URLs using the /*/filename.ext pattern:

  • Original URL: https://server.com/image.jpg?authToken=xyz
  • Rewritten URL: https://server.com/image.jpg/*/myimage_thumbnail.jpg?authToken=xyz

This ensures that files are downloaded with your custom filenames including suffixes.

Use Cases:

  • Single asset download - download specific file versions of a known asset
  • Batch processing from search results - use with n8n's "Execute Once for Each Item" to download multiple assets from search results
  • Selective file type download - download only thumbnails for quick previews, or only originals for processing
  • Custom filename generation - apply consistent naming patterns with suffixes and asset IDs
  • Workflow integration - download assets for further processing in subsequent nodes

Example Workflows:

Download original file only:

Download (login and download)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Files to Download: Original

Download all three versions with custom suffixes:

Download (login and download)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Files to Download: Thumbnail, Preview, Original
  - Filename Options:
    - Thumbnail Suffix: _thumb
    - Preview Suffix: _prev
    - Original Suffix: _full

Download thumbnails using asset ID as filename:

Download (login and download)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Files to Download: Thumbnail
  - Filename Options:
    - Use Asset ID as Filename: true

Batch download from search results:

Search (login and search)
  - Query: assetDomain:image AND rating:>3
→ Download (use token, Execute Once for Each Item enabled)
  - Asset ID: {{$json.id}}
  - Files to Download: Preview, Original
  - Search Options:
    - Metadata to Return: description,keywords,rating

Download and process images:

Search → Download (use token, batch) → Edit Image → Upload to Cloud Storage

Token reuse for multiple downloads:

Login → Download (use token) → Download (use token) → Download (use token)

Integration with n8n Batch Processing:
The Download operation works with n8n's "Execute Once for Each Item" feature:

  1. Use Search operation to find multiple assets
  2. Enable "Execute Once for Each Item" on the Download node
  3. Reference the asset ID from search results: {{$json.id}}
  4. Each asset will be downloaded individually with proper error handling

This pattern works well for processing large numbers of assets from search results or other sources.

Download as ZIP Operation

The download as ZIP operation retrieves multiple assets as a compressed ZIP file:

Authentication Methods:

  • Login and Download: Log in automatically before downloading assets
  • Use Token from Previous Login: Use the token from a previous login for efficient workflows

Parameters:

  • ZIP Filename (required): Name of the ZIP file to download (e.g., assets.zip, my-export.zip)

Source Selection (required - exactly one must be chosen):

  • Asset IDs: Download specific assets by their IDs
    • Provide comma-separated list of asset IDs
    • Example: EgNUCWzhqBh8DxwRUtkzQ5,FpERTjYia2X81GoYQi7btF
  • Query: Download assets matching a search query
    • Provide query string (same format as Search operation)
    • Example: assetDomain:image
    • Supports Number of Assets parameter
  • Folder Path: Download assets from a specific folder
    • Provide full folder path
    • Example: /Demo Zone/Images
    • Supports Number of Assets parameter

Format Selection (required - exactly one must be chosen):

  • Original Files: Download original file versions
  • Preview Files: Download preview versions
  • Download Preset: Use a download preset for format conversion
    • Requires Download Preset ID
  • Custom Preview Format: Specify custom preview format
    • Requires Preview Format specification

Optional Parameters:

  • Number of Assets: Maximum number of assets to include in ZIP (default: 50)
    • Only applies to Query and Folder Path sources
    • Ignored for Asset IDs source (determined by list size)
  • Compression Level: ZIP compression level (0-9, default: 5)
    • 0 = No compression
    • 1 = Fastest compression
    • 5 = Default balanced compression
    • 9 = Best compression (slower)
  • Stream Response: Whether to stream ZIP directly (default: true)
    • True = Stream directly (faster start, no progress info)
    • False = Create temporary file (slower start, shows download progress)

Response:
Returns n8n binary data containing:

  • ZIP file with selected assets
  • JSON metadata:
    • filename: Name of the ZIP file
    • size: File size in bytes
    • mimeType: application/zip

Important - Mutual Exclusivity Rules:
The API enforces strict rules to prevent parameter conflicts:

  • Exactly ONE source must be selected: Asset IDs, Query, OR Folder Path
  • Exactly ONE format must be selected: Original Files, Preview Files, Download Preset, OR Custom Preview Format
  • The UI enforces these rules by showing conditional fields based on dropdown selections

Use Cases:

  • Batch downloads - download multiple assets at once for offline use
  • Backup workflows - create backups of folder contents or search results
  • Asset distribution - package assets for sharing or distribution
  • Export by query - export all assets matching specific criteria

Example Workflows:

Download specific assets as original files:

Download as ZIP (login and download)
  - ZIP Filename: my-assets.zip
  - Source Selection: Asset IDs
  - Asset IDs: EgNUCWzhqBh8DxwRUtkzQ5,FpERTjYia2X81GoYQi7btF
  - Format Selection: Original Files

Download all images from a folder as previews:

Download as ZIP (login and download)
  - ZIP Filename: folder-previews.zip
  - Source Selection: Folder Path
  - Folder Path: /Demo Zone/Images
  - Format Selection: Preview Files
  - Optional Parameters:
    - Number of Assets: 100
    - Compression Level: 9 - Best Compression

Download query results with download preset:

Download as ZIP (login and download)
  - ZIP Filename: exported-images.zip
  - Source Selection: Query
  - Query String: assetDomain:image AND rating:>3
  - Format Selection: Download Preset
  - Download Preset ID: web-optimized
  - Optional Parameters:
    - Number of Assets: 50

Token reuse for multiple downloads:

Login → Download as ZIP (use token) → Download as ZIP (use token) → Download as ZIP (use token)

Update Operation

The update operation allows you to update existing assets in WoodWing Assets Server 6:

Authentication Methods:

  • Login and Update: Log in automatically before updating the asset
  • Use Token from Previous Login: Use the token from a previous login for efficient workflows

Parameters:

  • Asset ID (required): The WoodWing Assets Server ID of the asset to update (e.g., 5LMAQTW9qfhANn7f6JJVpl)
  • Update File (optional): Whether to upload a new file to replace the existing asset file (default: false)
  • Binary Property (conditionally required): Name of the binary property that contains the file to upload (required when Update File is true, default: "data")

Note: The asset ID determines the location and identity of the asset - no filename or folder path parameters are needed.

Advanced Options:

  • Clear Checkout State: Control checkout field clearing behavior (Not Set/True/False, default: Not Set)
    • When true: checked-out fields are cleared when FileData is included
    • When false: checked-out fields are maintained
    • When not set: uses server default behavior (typically true)
  • Keep Metadata: Whether to maintain existing Assets metadata (default: false)
    • When true: existing metadata is preserved (except technical fields like fileSize)
    • When false: metadata may be overridden based on server configuration
  • Metadata: A JSON encoded object with properties that match Assets Server metadata field names. Example: {"description": "Updated description", "keywords": "updated,keywords"}
  • Metadata to Return: Comma-separated list of metadata fields to return. Leave empty for minimal fields, use "all" for all fields.
  • Next URL: URL to redirect to after successful update. Use ${ID} as placeholder for the asset ID.
  • Parse Metadata Modifications: Enable parsing of "+" and "-" characters in metadata values for adding/removing values (default: true)
    • When true: use "+value" to add, "-value" to remove values from multi-value fields
    • When false: treats "+" and "-" as literal characters

Response:
Returns a JSON object with asset information including:

  • id: The asset ID
  • metadata: All metadata about the updated asset
  • permissions: User permissions for the asset
  • thumbnailHits: Thumbnail information (for image/video files)
  • originalUrl: URL to access the original file

Check-in Behavior:
When an asset is checked-out and FileData is included in the update, the asset is automatically checked-in (all checkedOut fields are reset). This behavior can be controlled with the Clear Checkout State option.

Example Workflows:

Update metadata only:

Update (login and update)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Update File: false
  - Advanced Options:
    - Metadata: {"rating": 5, "status": "Final"}

Update file only:

Read Binary File → Update (login and update)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Update File: true
  - Binary Property: data

Update both file and metadata:

Read Binary File → Update (login and update)
  - Asset ID: 5LMAQTW9qfhANn7f6JJVpl
  - Update File: true
  - Binary Property: data
  - Advanced Options:
    - Metadata: {"description": "Updated with new version"}
    - Keep Metadata: true

Token reuse for multiple updates:

Login → Update (use token) → Update (use token) → Update (use token)

Create Folder Operation

The create folder operation allows you to create one or more folders in WoodWing Assets Server 6:

Authentication Methods:

  • Login and Create: Automatically authenticates before creating folders (simpler workflow)
  • Use Token from Previous Login: Reuse an authToken from a previous Login operation (efficient for multiple operations)

Parameters:

  • Folder Path (required): Full path of the folder to create (e.g., /Demo Zone/My Folder)
  • Additional Folders (optional): Multiline text field - add one folder path per line to create multiple folders in a single request
    • Note: More than 50 folders may cause URL length issues

Response:
Returns a JSON object with folder paths as keys and their creation status as values:

  • "created": Folder was successfully created
  • "already exists": Folder already exists
  • "access denied": No permission to create folder
  • Error message: Specific error describing why folder could not be created

Example Workflows:

Create single folder:

Login → Create Folder (use token)

Create multiple folders in one request (via script/bulk):

Create Folder (login and create)
  - Folder Path: /Demo Zone/Main Folder
  - Additional Folders:
    /Demo Zone/Subfolder 1
    /Demo Zone/Subfolder 2
    /Demo Zone/Subfolder 3

Token reuse for multiple operations:

Login → Create Folder (use token) → Search (use token) → Create Folder (use token)

Search Operation

The search operation allows you to query assets with the following features:

Authentication Methods:

  • Login and Search: Automatically authenticates before searching (simpler workflow)
  • Use Token from Previous Login: Reuse an authToken from a previous Login operation (efficient for multiple searches)

Search Parameters:

  • Search Query (required): Query string to find assets (e.g., filename:*.jpg, assetDomain:image)
  • Number of Hits: Maximum results to return (optional, only included in request if specified)
  • Sort: Sort order (optional, only included in request if specified)

Advanced Options:

  • Metadata to Return: Comma-separated list of metadata fields to include (always sent with empty value if not specified)
  • Return Highlighted Text: Include text snippets with highlighted search terms (always sent, defaults to false)
  • Return Thumbnail Hits: Include thumbnail information in results (only sent if enabled)
  • Log Search: Log this search on the server for analytics (only sent if enabled)
  • Show Original Storage Path: Expand results to show original file system paths (only sent if enabled)

Response:
Returns a search results object containing:

  • totalHits: Total number of matching assets
  • hits: Array of asset objects with metadata, preview URLs, and thumbnail URLs
  • firstResult: Starting index of results
  • maxResultHits: Maximum number of results returned

Example Workflows:

Token Reuse (efficient for multiple searches):

Login → Search (use token) → Search (use token) → Search (use token)

Single Operation:

Search (login and search)

Resources

About

This community node is developed and maintained by 3f8h.net / electronic publishing.

WoodWing Assets Server 6 is a Digital Asset Management (DAM) system by WoodWing Software. This node specifically supports the on-premises version 6 of WoodWing Assets. For more information about WoodWing Assets, visit woodwing.com.

License

MIT

Discussion