HomeAboutSearch in the collections of assets.

Search in the collections of assets.

22Aug2011 Posted by admin

Returns a list of collections based on search patterns or CQL. Will return master/slaved collections, when access allowed. The number of videos field in each collection (numofvideos) reflects the number of videos in the collection. However, for master-slaved collections, this number will only hold the number of assets that are also master-slaved to your client application. If a master-slaved collection has no accessable assets, the collection is omitted from the results.

Request URL

/collection [GET]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
acl_user_id (ALPHA_NUM)Authentication parameter, for including the collections that are private.Optional-
asset_id (ALPHA_NUM)Search within the collection of this supplied asset ID.Optional-
calculate_total_count (BOOL)Calculate the number of rows in the complete scope of the search. Performance wise to use this parameter with value 'FALSE' if you don't need to know the total number of rows in your scope result.OptionalTRUE-
calculate_total_numofvideos (BOOL)Calculate exact total number of videos in the search. Performance wise to use this parameter with value 'FALSE' if you don't need to know the exact total number of videos in your scope result.OptionalTRUE-
category[] (BOOL)Search parameter, try to use CQL instead.Optional-
category_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
changed[] (DATETIME)Search parameter, try to use CQL instead.Optional-
changed_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
cql (STRING)The CQL search string, used for extended and complex search options.Optional-
created[] (DATETIME)Search parameter, try to use CQL instead.Optional-
created_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
description[] (STRING)Search parameter, try to use CQL instead.Optional-
description_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
fav_user_id (ALPHA_NUM)Search within the favorites of this supplied user ID.Optional-
group_id[] (STRING)Search parameter, try to use CQL instead.Optional-
group_id_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
hide_empty_assets (BOOL)Do not include assets that do not have mediafiles.OptionalFALSE-
is_public_list (BOOL)TRUE = include private assets, FALSE = exclude private assets (default),OptionalFALSE-
limit (INT)Limit of the items of the result set.Optional10-
mediamosa_version (MEDIAMOSA_VERSION)Provide the version to get the REST call returned in the format of the specified MediaMosa version. Keep empty or skip to retrieve in current (latest) version. Provide '2' to retrieve the REST call in 2.x format. Or be more specific by providing up to 3 digits; '2.3.0'. This setting will override any setting used by client application or the default setting in MediaMosa.Optional-
offset (UINT)The starting items position in the result set.Optional0-
operator (ALPHA)For non-CQL search only; provide either OR or AND for search parameters..Optionaland-
order_by (ALPHA_NUM_UNDERSCORE)On what column the result set should be ordered.Optional-
order_direction (ALPHA)The direction of the result set.Optionalasc-
owner_id[] (STRING)Search parameter, try to use CQL instead.Optional-
owner_id_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
private[] (BOOL)Search parameter, try to use CQL instead.Optional-
private_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
public[] (BOOL)Search parameter, try to use CQL instead.Optional-
public_assign (BOOL)Search on the public assign flag status of the collection.Optional-
public_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
title[] (STRING)Search parameter, try to use CQL instead.Optional-
title_match (STRING)Type matching for search parameter, try to use CQL instead.
Value (when supplied) must be either "contains" or "exact" or "begin".		Optionalcontains-
user_id (ALPHA_NUM)Alias for acl_user_id parameter, is chosen above acl_user_id.Optional-

Example Request

collection?is_public_list=false&calculate_total_count=true&operator=and&limit=10&order_direction=asc

Example Response

<items>
  <item id="1">
    <coll_id>1</coll_id>
    <title>News</title>
    <description>News related assets.</description>
    <app_id>3</app_id>
    <owner_id>testuser</owner_id>
    <group_id>videoandimages</group_id>
    <isprivate>FALSE</isprivate>
    <private>FALSE</private>
    <public>TRUE</public>
    <category>TRUE</category>
    <created>2009-11-06 17:50:36</created>
    <changed>2009-05-27 21:47:34</changed>
    <is_unappropriate>FALSE</is_unappropriate>
    <public_assign>TRUE</public_assign>
    <numofvideos>14</numofvideos>
  </item>
  <item id="2">
  ....
  </item>
</item>