How to get collection-, item-, shape- and component metadata in one call

This guide contains parts from a user case.

Customer question;

"Is there a mechanism to extract all the metadata –parent collection, child collections, items in the child collections, shapes in the items, and technical metadata of the components of the shape in a single call to Vidispine?"

Resolution;

It is possible to fetch all that information in just one call, by doing a "collection-item" search;

CODE

PUT /API/search?content=metadata,shape @searchdoc.xml

<?xml version="1.0" encoding="utf-8"?>
<ItemSearchDocument xmlns="http://xml.vidispine.com/schema/vidispine" version="2">
<operator operation="OR">
  <field>
    <name>__ancestor_collection</name>
  <value>[collection-id]</value>
  </field>
  <field>
    <name>collectionId</name>
    <value>[collection-id]</value>
  </field>
</operator>
</ItemSearchDocument>

This example will create an output XML containing the search result.

More information on different search parameters for items and collections;

http://apidoc.vidispine.com/latest/ref/search.html#id2