Show Menu
TOPICS×

SearchFilter

Filters that help you define search criteria to make searches more efficient.
Syntax

Parameters

Name Type Description
folder xsd:string Specify the folder you want to search. Leave blank to search across and entire company.
includeSubfolders xsd:boolean Set to:
  • True : To search the named folder and all subfolders.
  • False : To search the named folder only.
assetTypeArray type:StringArray A list of asset types that you want to return in a search. For example, image .
excludeAssetTypeArray type:StringArray Specify an asset type to exclude from a search. For example, image.
assetSubTypeArray type:StringArray A list of asset sub-types you want to return in a search. For example, for an AssetSet , you can search for the MediaType sub-type.
strictSubTypeCheck xsd:boolean
An optional boolean flag that specifies whether to return assets with no subtype when assetSubTypeArray is passed.
If true, then only assets with one of the specified subtypes is returned.
If false, then assets with no subtype are also returned.
Defaults is false.
excludeByproducts xsd:boolean Set to:
  • True : To return original assets only.
  • False : To return generated content. For example, images from an uploaded PDF.
projectHandle xsd:string Handle to the project you want to search.
publishState xsd:string Specify:
  • MarkedForPublish to return published assets only.
  • NotMarkedForPublish to return unpublished assets only.
Note: Leave blank to search for all published state types.
trashState xsd:string Specify:
  • Any to return assets regardless of their trash state.
  • NotInTrash to return 'normal' assets.
  • InTrash to return assets from the trash.