Search for assets based on input parameters and return a list of found assets.

17May2010 Posted by admin

Request URL

/asset [GET]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)	Description	Required	Default value	Max. length
aggregatieniveau[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
aggregatieniveau_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
app_id_search[] (INT)	Search parameter, try to use CQL instead.	Optional		-
app_id_search_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
asset_id[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
asset_id_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
aut_domain (STRING)	Authentication parameter.	Optional		-
aut_group_id[] (ALPHA_NUM)	Authentication parameter.	Optional		-
aut_realm (STRING)	Authentication parameter.	Optional		-
aut_user_id (ALPHA_NUM)	Authentication parameter.	Optional		-
auteursrechten[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
auteursrechten_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
batch_id (ALPHA_NUM)	Search within batch.	Optional		-
beoogde_eindgebruiker[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
beoogde_eindgebruiker_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
beoogde_leeftijdsgroep[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
beoogde_leeftijdsgroep_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
beschrijving[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
beschrijving_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
calculate_total_count (BOOL)	Calculate the number of rows in the complete scope of the search and store it in the header parameter 'item_count_total'. Performance will drasticly improve with value 'FALSE' if you don't need to know the total number of assets in your scope result. If you provide 'FALSE', then 'item_count_total' value in the header will always be the number of items returned, same as 'item_count'.	Optional	TRUE	-
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".	Optional	contains	-
classificatie[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
classificatie_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
coll_id[] (ALPHA_NUM)	Search within these collections.	Optional		-
context[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
context_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
contributor[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
contributor_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
coverage_spatial[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
coverage_spatial_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
coverage_temporal[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
coverage_temporal_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
cql (STRING)	The CQL search string, used for extended and complex search options.	Optional		-
created[] (DATETIME)	Metadata (qualified_dublin_core) 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".	Optional	contains	-
creator[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
creator_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
date[] (DATETIME)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
date_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
description[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
description_abstract[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
description_abstract_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
description_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
fav_user_id (ALPHA_NUM)	Search within the favorites of this supplied user ID.	Optional		-
filename[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
filename_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
format[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
format_extent[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
format_extent_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
format_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
format_medium[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
format_medium_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
granted (BOOL)	Include a flag on each asset to indicate access. When providing with TRUE, the result will include assets where no access is available.	Optional	TRUE	-
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".	Optional	contains	-
hasformat[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
hasformat_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
hide_empty_assets (BOOL)	Do not include assets that do not have mediafiles.	Optional	FALSE	-
identificatiecode[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
identificatiecode_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
identifier[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
identifier_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
is_public_list (BOOL)	Include or hide private assets in result. TRUE: exclude private assets, FALSE: include private assets.	Optional	FALSE	-
isformatof[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
isformatof_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
isreferencedby[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
isreferencedby_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
issued[] (DATETIME)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
issued_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
kosten[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
kosten_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
language[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
language_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
license[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
license_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
limit (INT)	Limit of the items of the result set.	Optional	10	-
mediafile_container_type[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
mediafile_container_type_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
mediafile_duration[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
mediafile_duration_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
mime_type[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
mime_type_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
numofplays[] (INT)	Search parameter, try to use CQL instead.	Optional		-
numofplays_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
numofviews[] (INT)	Search parameter, try to use CQL instead.	Optional		-
numofviews_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
offset (UINT)	The starting items position in the result set.	Optional	0	-
omschrijving_rechten[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
omschrijving_rechten_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
operator (ALPHA)	For non-CQL search only; provide either OR or AND for search parameters..	Optional	and	-
order_by (ALPHA_NUM_UNDERSCORE)	On what column the result set should be ordered.	Optional		-
order_direction (ALPHA)	The direction of the result set.	Optional	asc	-
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".	Optional	contains	-
provider_id[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
provider_id_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
publisher[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
publisher_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
reference_id[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
reference_id_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
relation[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
relation_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
return_asset_ids (BOOL)	Return only the found asset ids.	Optional	FALSE	-
rights[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
rights_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
rightsholder[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
rightsholder_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
schemanaam[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
schemanaam_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
show_collections (BOOL)	Include collection information of each assets, when available.	Optional	FALSE	-
show_deleted (BOOL)	Include deleted assets for OAI. The deleted assets are not complete assets, these assets are empty and are only an indication that they are deleted.	Optional	FALSE	-
show_stills (BOOL)	Include stills in output.	Optional	TRUE	-
sleutelwoord[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
sleutelwoord_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
soort_leermateriaal[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
soort_leermateriaal_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
source[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
source_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
status[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
status_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
subject[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
subject_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
taal[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
taal_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
titel[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
titel_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
title[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
title_alternative[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
title_alternative_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
title_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
type[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
type_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
user_id (ALPHA_NUM)	Alias for aut_user_id parameter, is chosen above aut_user_id.	Optional		-
versie[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
versie_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
videotimestamp[] (DATETIME)	Search parameter, try to use CQL instead.	Optional		-
videotimestamp_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
videotimestampmodified[] (DATETIME)	Search parameter, try to use CQL instead.	Optional		-
videotimestampmodified_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-

Example Request

/asset?limit=200&order_by=created&order_direction=desc&title[]=test [GET]
/asset?limit=2&offset=3 [GET]

Example Response

<items>
  <item id="1">
    <asset_id>10061</asset_id>
    <app_id>1</app_id>
    <provider_id></provider_id>
    <owner_id>av-user-naa</owner_id>
    <group_id>beeldengeluid</group_id>
    <videotimestamp>2004-09-10 22:22:08</videotimestamp>
    <videotimestampmodified>2004-09-10 22:22:08</videotimestampmodified>
    <play_restriction_start></play_restriction_start>
    <play_restriction_end></play_restriction_end>
    <reference_id></reference_id>
    <isprivate>FALSE</isprivate>
    <is_protected>FALSE</is_protected>
    <dublin_core>
      <type>Video</type>
      <language>EN</language>
      <title>kurkentrekker.mpg</title>
      <creator>naa</creator>
      <publisher>naa</publisher>
     <description>this kurkentrekker.mpg of naa was n/naa/mpeg/kurkentrekker.mpg</description>
      <date>2004-09-10 22:22:08</date>
      <format></format>
      <subject></subject>
      <contributor></contributor>
      <identifier></identifier>
      <source></source>
      <relation></relation>
      <coverage_temporal></coverage_temporal>
      <coverage_spatial></coverage_spatial>
      <rights></rights>
    </dublin_core>
    <qualified_dublin_core>
      <title_alternative></title_alternative>
      <description_abstract></description_abstract>
      <created></created>
      <issued></issued>
      <hasformat></hasformat>
      <isformatof></isformatof>
      <format_medium></format_medium>
      <format_extent></format_extent>
      <license></license>
      <rightsholder></rightsholder>
      <isreferencedby></isreferencedby>
    </qualified_dublin_core>
  </item>
  <item id="2">
    <asset_id>10062</asset_id>
    <app_id>1</app_id>
    <provider_id></provider_id>
    <owner_id>av-user-naa</owner_id>
    <group_id>beeldengeluid</group_id>
    <videotimestamp>2004-09-10 22:22:08</videotimestamp>
    <videotimestampmodified></videotimestampmodified>
    <play_restriction_start></play_restriction_start>
    <play_restriction_end></play_restriction_end>
    <reference_id></reference_id>
    <isprivate>FALSE</isprivate>
    <is_protected>FALSE</is_protected>
    <created>2008-04-07 09:53:44</created>
    <changed>2008-04-17 23:44:44</changed>
    <dublin_core>
      <type>Video</type>
      <language>EN</language>
      <title>interculturele-mpeg1-vhs.mpg</title>
      <creator>naa</creator>
      <publisher>naa</publisher>
     <description>this interculturele-mpeg1-vhs.mpg of naa was n/naa/mpeg/interculturele-mpeg1-vhs.mpg</description>
      <date>2004-09-10 22:22:08</date>
      <format></format>
      <subject></subject>
      <contributor></contributor>
      <identifier></identifier>
      <source></source>
      <relation></relation>
      <coverage_temporal></coverage_temporal>
      <coverage_spatial></coverage_spatial>
      <rights></rights>
    </dublin_core>
    <qualified_dublin_core>
      <title_alternative></title_alternative>
      <description_abstract></description_abstract>
      <created></created>
      <issued></issued>
      <hasformat></hasformat>
      <isformatof></isformatof>
      <format_medium></format_medium>
      <format_extent></format_extent>
      <license></license>
      <rightsholder></rightsholder>
      <isreferencedby></isreferencedby>
    </qualified_dublin_core>
  </item>
</items>