Skip to main content
Skip table of contents

Collection Relations [C ARC]

For managing collections it may be helpful to know the semantics of the collections' contents. A possible use-case would be the series - season - episode structure:

  • The topmost collection stands for the series.

  • The series collection contains one ore more collections denoting each season.

  • Each season collection contains multiple items - one for each episode.

The default VidiCore collection only “knows” the technical type of each child entry, i.e. a collection or an item. To store the semantics of each child the key-value metadata entry relation is used. It can contain the following values:

Value

Meaning

isSeasonOf

The child collection is a a season of the this collection.

isEpisodeOf

The child item (or collection) is an episode of this collection.

A season collection containing one episode item would look like this:

CODE
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CollectionDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <loc>http://localhost:8080/API/collection/VX-6/</loc>
    <id>VX-6</id>
    <name>Simpsons Season 371</name>
    <content>
        <id>VX-12881</id>
        <uri>http://localhost:8080/API/item/VX-12881</uri>
        <type>item</type>
        <reference>5f0e4338-e1c9-4832-88f8-253f2c45a870</reference>
        <metadata>
            <field>
                <key>relation</key>
                <value>isEpisodeOf</value>
            </field>
        </metadata>
    </content>
</CollectionDocument>

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.