Search [VC 21.3 GEN]

Content Parameters:

See Retrieving item information

Query Parameters:

• first (integer) – From the resulting list of items, start return list from specified offset. Default is 1, start return list from beginning.

• cursor (string) –

  • * - The initial cursor.

  • string-from-search - Cursor string returned from the search results.

  If set, the cursorMark / search after features from Solr/Elasticsearch are used to improve the deep paging performance during a search.

  When cursor is used, the value of first will be ignored.

   

• number (integer) – The number of entities to fetch. Default is 100.

• count (boolean) –

  • true (default) - Return hits in result.

  • false - Do not return hits in result, in order to produce results faster.

   

• p (string) – Comma-separated list of paths specifying the content to include. Overrides the content and filter parameters.

• content (string) – Comma-separated list of the types of content to retrieve. Valid values are metadata, uri, shape, poster, thumbnail, access, merged-access, external.

• interval (string) –

  Comma-separated list

  • time-span - Filter out metadata, return only metadata for specified time span.

  • generic - Return all non-timed metadata.

  • all (default) - Return all metadata, same as interval=generic,-INF-+INF

  • result - Can be used when retrieving metadata from a search result. Will return time spans that overlap with the search result. (New in 5.5.)

   

• field (string) –

  Comma-separated list.

  • field-name - Return specified field.

  • field-name “:” new-name - Return specified field, renamed to a new name in return value.

  • ”-” field-name - Exclude specified field.

  • (default) - Return all fields.

   

• group (string) –

  Comma-separated list.

  • group-name - Return specified group.

  • group-name + - Return specified group and subgroups.

  • group-name : new-name - Return specified group, renamed to a new name in return value.

  • - group-name - Exclude specified group.

  • (default) - Return all groups.

   

• language (string) –

  Comma-separated list.

  • language-tag - Return metadata for specific language, e.g. en_US. Wildcards may be used, e.g. *_CA for both Canadian French and Canadian English.

  • none - Return all metadata without language specification.

  • all (default) - Return all metadata, with or without language specification.

   

• sampleRate (string) – Convert all outgoing time instants to specified rate. NB! Time codes which cannot be expressed in an integer number of samples will be returned as a decimal number, with risk of losing precision.

• track (string) –

  Comma-separated list.

  • track-type track-number - Return metadata for specified track. Example of track is A2.

  • track-type t1 - t2 - Return metadata for specified track interval, e.g. A2-4.

  • track-type * - Return metadata for all tracks of specified type, e.g. A*.

  • generic - Return all non-tracked metadata.

  • all (default) - All metadata, with or without track specification, are returned.

   

• include (string) – A list of keys. Includes additional field specific data. Additionally, if set to type the type definition of the field will be retrieved.

• includeValues (boolean) – Return the value enumeration for each metadata field.

• conflict (string) –

  • yes (default) - Include all metadata conflicts, unresolved.

  • no - Return conflicts resolved according to field rules.

   

• terse (string) –

  • yes - Return metadata in terse format.

  • no (default) - Return metadata in verbose format.

   

• defaultValue (boolean) –

  • true - For unset fields, return default values.

  • false (default) - Do not return default values.

   

• includeTransientMetadata (boolean) –

  • true (default) - Include transient metadata.

  • false - Do not include transient metadata in response.

   

• revision (string) – Specifying which metadata revision to display. Only used if requesting a single item or collection.

• mergedType (string) – The type of operation to check for.

• mergedPermission (string) – The lowest required permission level.

• mergedExtradata (string) – Any possible extra data.

• uriType (string) – Comma-separated list of format types (container format) to return.

• scheme (string) – URI scheme to return.

• storageType (string) – Only return URIs for files from storages of this type.

• methodType (string) –

  Access method.

  • AUTO - Gives an APInoauth URI to the media. Access to file is tunneled through Vidispine.

  • AZURE_SAS - If the storage schema is azure:// you can get direct access to the media. The resulting URI will not tunnel through Vidispine but rather point directly to the media location at the azure storage.

   

• methodMetadata (string) – Metadata used with storage method.

• tag (string) – A URI parameter: Comma-separated list of shape tags to return.

• version (string) – Specifying which essence version to return for shapes. If special value all, display all versions. If special value latest (default), display latest version of shapes.

• closedFiles (boolean) –

  A URI parameter:

  • true (default) - Return only URIs that point to closed files.

  • false - Return all URIs.

   

• storage (string[]) – List of storage ids. Return only files from specific storages. Can be specified multiple times.

• storageGroup (string) – Storage group id. Return only files from storages specified in the storage group.

• noauth-url (boolean) –

  • true Return URIs that do not need authentication.

  • false (default) Return normal URIs

   

• baseURI (string) – Which base URI to use for the thumbnail URLs.

• save (boolean) –

  • true - Returns a 303 See Other, with a Location header containing an URI to fetch the search result

  • false (default) - Returns a regular search result

   

Produces:

• application/xml, application/json – SearchResultDocument

Role:

_item_search

Role:

_collection_read

Role:

_metadata_read (content=metadata)

Role:

_item_uri (content=uri)

Role:

_thumbnail_read (content=poster and content=thumbnail)

Role:

_access_control_read (content=access and content=merged-access)

Role:

_item_id_read (content=external)

Content Parameters:

See Retrieving item information

Query Parameters:

• first (integer) – From the resulting list of items, start return list from specified offset. Default is 1, start return list from beginning.

• cursor (string) –

  • * - The initial cursor.

  • string-from-search - Cursor string returned from the search results.

  If set, the cursorMark / search after features from Solr/Elasticsearch are used to improve the deep paging performance during a search.

  When cursor is used, the value of first will be ignored.

   

• number (integer) – The number of entities to fetch. Default is 100.

• count (boolean) –

  • true (default) - Return hits in result.

  • false - Do not return hits in result, in order to produce results faster.

   

• p (string) – Comma-separated list of paths specifying the content to include. Overrides the content and filter parameters.

• content (string) – Comma-separated list of the types of content to retrieve. Valid values are metadata, uri, shape, poster, thumbnail, access, merged-access, external.

• interval (string) –

  Comma-separated list

  • time-span - Filter out metadata, return only metadata for specified time span.

  • generic - Return all non-timed metadata.

  • all (default) - Return all metadata, same as interval=generic,-INF-+INF

  • result - Can be used when retrieving metadata from a search result. Will return time spans that overlap with the search result. (New in 5.5.)

   

• field (string) –

  Comma-separated list.

  • field-name - Return specified field.

  • field-name “:” new-name - Return specified field, renamed to a new name in return value.

  • ”-” field-name - Exclude specified field.

  • (default) - Return all fields.

   

• group (string) –

  Comma-separated list.

  • group-name - Return specified group.

  • group-name + - Return specified group and subgroups.

  • group-name : new-name - Return specified group, renamed to a new name in return value.

  • - group-name - Exclude specified group.

  • (default) - Return all groups.

   

• language (string) –

  Comma-separated list.

  • language-tag - Return metadata for specific language, e.g. en_US. Wildcards may be used, e.g. *_CA for both Canadian French and Canadian English.

  • none - Return all metadata without language specification.

  • all (default) - Return all metadata, with or without language specification.

   

• sampleRate (string) – Convert all outgoing time instants to specified rate. NB! Time codes which cannot be expressed in an integer number of samples will be returned as a decimal number, with risk of losing precision.

• track (string) –

  Comma-separated list.

  • track-type track-number - Return metadata for specified track. Example of track is A2.

  • track-type t1 - t2 - Return metadata for specified track interval, e.g. A2-4.

  • track-type * - Return metadata for all tracks of specified type, e.g. A*.

  • generic - Return all non-tracked metadata.

  • all (default) - All metadata, with or without track specification, are returned.

   

• include (string) – A list of keys. Includes additional field specific data. Additionally, if set to type the type definition of the field will be retrieved.

• includeValues (boolean) – Return the value enumeration for each metadata field.

• conflict (string) –

  • yes (default) - Include all metadata conflicts, unresolved.

  • no - Return conflicts resolved according to field rules.

   

• terse (string) –

  • yes - Return metadata in terse format.

  • no (default) - Return metadata in verbose format.

   

• defaultValue (boolean) –

  • true - For unset fields, return default values.