MediaCockpit DAM icon

MediaCockpit DAM

Interact with MediaCockpit DAM REST API

Actions9

Search Assets

AI-generated

Summary

Search assets in the MediaCockpit DAM system using either a simple text query or an advanced custom JSON filter, with options to control result pagination and output format.

Inputs

  • Search Mode — Choose between 'Simple Search' (text query) or 'Advanced Filter' (custom JSON filter) for the asset search.
  • Search Query — A text string to search asset content, used only in Simple Search mode.
  • Filter JSON — Custom JSON filter object for advanced search queries; replace empty "param" values with the desired search term.
  • Build JSON — Optional JSON configuration to customize the output format; defaults to the standard output if left empty.
  • Return All Results — Boolean to specify whether all search results should be returned or limited to a maximum number.
  • Limit — Maximum number of results to return if 'Return All Results' is false.

Output shape

A list of asset objects matching the search criteria, each as a separate JSON item.

Pagination is handled internally, returning all or up to 'Limit' results based on 'Return All Results'. If no assets are found, a single item with an empty assets array is returned.

Examples

Example 1: Perform a simple text search for assets containing "invoice" and return up to 10 results.

Set 'Search Mode' to 'Simple Search', 'Search Query' to 'invoice', 'Return All Results' to false, and 'Limit' to 10.

Example 2: Run an advanced search using a custom JSON filter targeting assets with a specific metadata field.

Set 'Search Mode' to 'Advanced Filter', provide the filter JSON with criteria targeting the metadata field, optionally customize output with 'Build JSON', and specify result limits as needed.

Links

Discussion