HomeAboutSearch in the collections of specified asset ID.

Search in the collections of specified asset ID.

22Aug2011 Posted by admin

Request URL

/asset/$asset_id/collection [GET]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
asset_id (ALPHA_NUM)Search within the collection of this supplied asset ID.Required-
acl_user_id (ALPHA_NUM)Authentication parameter, for including the collections that are private.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

/asset/VlN2ZDKv9rpsfmBAWpvfiw1zQ6z/collection

Example Response

<items>
  <item id="1">
    <coll_id>EjDv4oI50sjPu01WXdXH5Eva</coll_id>
    <title>CDE Collectieup</title>
    <description>Collectie CDE</description>
    <app_id>5</app_id>
    <owner_id>SURFgroepen.smibuildings</owner_id>
    <group_id>default</group_id>
    <isprivate>FALSE</isprivate>
    <private>FALSE</private>
    <public>TRUE</public>
    <category>FALSE</category>
    <created>2009-05-27 10:37:43</created>
    <changed>2009-09-18 12:04:31</changed>
    <is_unappropriate>FALSE</is_unappropriate>
    <public_assign>FALSE</public_assign>
    <numofvideos>1</numofvideos>
  </item>
</items>