Motivation

Collections are generic storage containers and can for example be used as:

  • A sort of folder structure, where files are mapped as items and sub folders are mapped as sub collections in the hierarchy.

  • A simple container for a number of items and collections.

  • A representation of a Non Linear Editor (NLE) “bin”.

  • A representation of an entity in your domain.

Example

Request:

POST /collection?name=Pending%20review

Response:

<CollectionDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <loc>http://localhost:8080/API/collection/VX-16</loc>
  <id>VX-16</id>
  <name>Pending review</name>
</CollectionDocument>
CODE

Resources

Resources tangent to the UC can be found here:

https://apidoc.vidispine.com/latest/ref/collection.html

Resources specific to this UC:

https://apidoc.vidispine.com/latest/ref/collection.html#create-a-collection

How to

Please view the explanation in:

https://apidoc.vidispine.com/latest/item/collection.html#creating-collections