UC Create a Placeholder Collection [C IG]

Motivation

Placeholder collections are a specific variant of collections that are relevant during the planning phase of a contribution or a programme. See Asset Placeholders & Metadata Containers for details.

Example

Placeholder Creation

Request:

POST /collection?name=Tribute%20To%20Charly%20Parker&externalId=e9d73bbc-e60c-4ac4-9fa3-70424a4f345f

CODE

<CollectionDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <name>Tribute To Charly Parker</name>
  <metadata>
    <timespan start="-INF" end="+INF">
       <field>
         <name>title</name>
         <value>Tribute To Charly Parker</value>
       </field>
       <field>
         <name>V3_CollectionType</name>
         <value>MetadataContainer</value>
      </field>
    </timespan>
  </metadata>
</CollectionDocument>

Response:

CODE

<CollectionDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <loc>http://localhost:8080/API/collection/VX-656</loc>
  <id>VX-656</id>
  <name>Tribute To Charly Parker</name>
</CollectionDocument>

Notes:

Relevant metadata should be specified in the collection creation call shown above. This ensures that the metadata values are present on the collection when receiving a collection creation notification.
For the same reason, please specify the the external ID directly when creating the collection if your system is working with external IDs. Omit the externalId query parameter otherwise.
The metadata field V3_CollectionType must be set to MetadataContainer or - if applicable to Production - to denote this VidiCore collection as a placeholder. See Collection Types for details.

Deletion Lock

In systems with house-keeping mechanisms, you should set a deletion lock on the newly created collection.

Request:

POST /collection/e9d73bbc-e60c-4ac4-9fa3-70424a4f345f/deletion-lock

CODE

<DeletionLockDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <expiryTime>2025-09-30T12:00:00+02:00</expiryTime>
  <metadata>
    <field>
      <key>reason</key>
      <value>A valid reason</value>
   </field>
  </metadata>
</DeletionLockDocument>

Response:

CODE

<DeletionLockDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <id>VX-1</id>
    <user>admin</user>
    <expiryTime>2025-09-30T12:00:00.000+02:00</expiryTime>
    <modified>2025-02-21T08:40:40.131+01:00</modified>
    <entityType>Collection</entityType>
    <entityId>VX-656</entityId>
    <metadata>
        <field>
            <key>reason</key>
            <value>A valid reason</value>
        </field>
    </metadata>
</DeletionLockDocument>

Further Operations

Further operations are working the same way as for other collection types:

Resources

Resources tangent to the UC can be found here:

https://apidoc.vidispine.com/latest/ref/collection.html
https://apidoc.vidispine.com/latest/ref/deletion-lock.html

Resources specific to this UC:

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

How to

Please view the explanation in:

https://apidoc.vidispine.com/latest/item/collection.html#creating-collections
https://apidoc.vidispine.com/latest/ref/deletion-lock.htmll#create-a-lock