Browse items and collections¶

GET /search¶

Browses items and collections.

Content Parameters:
	See Retrieving item information
Matrix Parameters:
	first – Integer, from resulting list of items, start return list from specified offset. Default is 1, start return list from beginning. number – Integer, set a limit on maximum number of hits. Default 100.
Query Parameters:
	count – true (default) - Return hits in result. false - Do not return hits in result, in order to produce results faster.
Produces:	application/xml, application/json – SearchResultDocument
Role:	_item_search
Role:	_collection_read

Search items and collections¶

PUT /search¶

Searches items and collections with a shared search query.

Note

This resource doesn’t support joint search, use PUT /item, PUT /search/shape or PUT /search/file for item, shape or file joint search respectively.

Content Parameters:
	See Retrieving item information
Matrix Parameters:
	first – Integer, from resulting list of items, start return list from specified offset. Default is 1, start return list from beginning. number – Integer, set a limit on maximum number of hits. Default 100.
Query Parameters:
	count – true (default) - Return hits in result. false - Do not return hits in result, in order to produce results faster.
Accepts:	application/xml, application/json – ItemSearchDocument
Produces:	application/xml, application/json – SearchResultDocument
Role:	_item_search
Role:	_collection_read

PUT /search?content=metadata&field=title
Content-Type: application/xml

<ItemSearchDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <field>
        <name>title</name>
        <value>Something</value>
    </field>
</ItemSearchDocument>

<SearchResultDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <hits>3</hits>
  <entry start="-INF" end="+INF" type="Item" id="DE-42">
    <item id="DE-42" start="-INF" end="+INF">
      <metadata>
        <revision>DE-278,DE-276,DE-277</revision>
        <timespan start="-INF" end="+INF">
          <field uuid="e527b7f3-1bfa-4067-8dde-753368c09617" user="admin" timestamp="2012-03-23T10:10:42.845+01:00" change="DE-278">
            <name>title</name>
            <value uuid="38609429-67d1-4357-980c-64e7559768ff" user="admin" timestamp="2012-03-23T10:10:42.845+01:00" change="DE-278">Something</value>
          </field>
        </timespan>
      </metadata>
    </item>
    <timespan start="-INF" end="+INF"/>
  </entry>
  <entry start="-INF" end="+INF" type="Collection" id="DE-13">
    <collection>
      <id>DE-13</id>
      <metadata>
        <revision>DE-273,DE-279</revision>
        <timespan start="-INF" end="+INF">
          <field uuid="c203856a-e8e3-4d50-8287-642821941791" user="admin" timestamp="2012-03-23T10:10:57.103+01:00" change="DE-279">
            <name>title</name>
            <value uuid="f80fb9a1-1eca-479a-8b1a-11d30f93fa5d" user="admin" timestamp="2012-03-23T10:10:57.103+01:00" change="DE-279">Something</value>
          </field>
        </timespan>
      </metadata>
    </collection>
    <timespan start="-INF" end="+INF"/>
  </entry>
  <entry start="-INF" end="+INF" type="Item" id="DE-37">
    <item id="DE-37" start="-INF" end="+INF">
      <metadata>
        <revision>DE-255,DE-280,DE-256</revision>
        <timespan start="-INF" end="+INF">
          <field uuid="f1ac0198-6b8f-43a0-9caa-e8c36e80eee8" user="admin" timestamp="2012-03-23T10:11:16.849+01:00" change="DE-280">
            <name>title</name>
            <value uuid="dcd6a3bb-bf70-4cb7-8d77-e2adfe1e3b1c" user="admin" timestamp="2012-03-23T10:11:16.849+01:00" change="DE-280">Something</value>
          </field>
        </timespan>
      </metadata>
    </item>
    <timespan start="-INF" end="+INF"/>
  </entry>
</SearchResultDocument>

Search shapes¶

GET /search/shape¶

PUT /search/shape¶

Searches shapes. Using GET is identical as performing a search with an empty search document.

Query Parameters:
	content – Comma-separated list of the types of content to retrieve, possible values are component, metadata, essenceVersion, tag, mimeType and *. count – true (default) - Return hits in result. false - Do not return hits in result, in order to produce results faster.
Matrix Parameters:
	first – Integer, from resulting list of items, start return list from specified offset. Default is 1, start return list from beginning. number – Integer, set a limit on maximum number of hits. Default 100.
Accepts:	application/xml, application/json – ShapeSearchDocument
Produces:	application/xml, application/json – ShapeListDocument
Role:	_item_shape_read

Search files¶

GET /search/file¶

PUT /search/file¶

Searches files. Using GET is identical as performing a search with an empty search document.

Note

This resource searches the same index and will produce the same results as GET /storage/(storage-id)/file. The only difference is the syntax, that is, the query/matrix parameters versus search documents. When using a search document it is also possible to perform joins.

Query Parameters:
	methodType – Return URLs with a particular methodType. By default, return URLs with empty methodType. see Storage methods. scheme – URI scheme to return. count – true (default) - Return hits in result. false - Do not return hits in result, in order to produce results faster.
Matrix Parameters:
	first – Integer, from resulting list of items, start return list from specified offset. Default is 1, start return list from beginning. number – Integer, set a limit on maximum number of hits. Default 100.
Accepts:	application/xml, application/json – FileSearchDocument
Produces:	application/xml, application/json – FileListDocument
Role:	_file_read

Optimize search index¶

POST /search/optimize¶

Query Parameters:
	blocking – true - The request will block until the Solr optimize request has finished. false (default) - Optimize will be scheduled and the request will return immediately. timeout – Integer, block for maximum number of specified milliseconds. Default is 0, which means block indefinitely.
Status Codes:	200 OK – If the operation finished successfully. Only if blocking=true. 202 Accepted – If the operation was accepted but not yet finished. 500 Internal Server Error – If an error occurs.
Role:	_administrator