Motivation

Collections and other content residing within a collection can easily be removed from that collection when needed.

Example

Removing a single collection from a collection:

Request

DELETE /collection/VX-2/VX-3?type=collection

Where VX-2 is the collection and VX-3 is the sub-collection which we want to remove from the collection.

Removing items in bulk

To remove multiple collections, we can pass a CollectionDocument specifying which collections to remove

PUT /collection/VX-2

With a body telling which collections to remove

<CollectionDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <loc>http://localhost:8080/API/collection/VX-2/</loc>
    <id>VX-2</id>

    <content mode="remove">
        <id>VX-3</id>
        <uri>http://localhost:8080/API/collection/VX-3</uri>
        <type>collection</type>
        <metadata/>
    </content>
    
    <content mode="remove">
        <id>VX-4</id>
        <uri>http://localhost:8080/API/collection/VX-4</uri>
        <type>collection</type>
        <metadata/>
    </content>
</CollectionDocument>
CODE

Note: This endpoint also supports the parameter clear which if set to true will remove any item or collection not specifically mentioned in the document from the collection.

Resources

For more details see:

https://apidoc.vidispine.com/latest/ref/collection.html#remove-an-item-library-or-collection-from-a-collection

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

How to

Further explanation can be found here:

https://apidoc.vidispine.com/21.4/item/collection.html#update-collection-content