Resource relations:relation-type

Overview

The relations:relation-type resource represents an available relation type of an asset.

Properties

The relations:relation-type resource has the following properties:

relationType

The relation type of the relation containing the direction. Examples: PARENT_CHILD_TEST.child, TEST_AUDIO.forward

entityTypes

An array that defines the valid types of objects for this relation type. Each entity type has the following properties:

  • kind: Entity kind (aa=asset, loc=location item).

  • type: The type of the related asset class. Examples: asset.AUDIO, sequence.EDL

labels

Labels for this relation type.

Link Relations

relations:create-relation

Create a relation from the current entity to another entity with this relation type.

Example

Example: relation type EPISODE_VIDEO.reverse of an asset in MediaCentral | Asset Management. 
 
{
  "relationType": "EPISODE_VIDEO.reverse",
  "entityTypes": [
    {
      "kind": "aa",
      "type": "asset.EPISODE"
    }
  ],
  "labels": {
    "de": "Episode",
    "en": "Episode",
    "es": "Episodio",
    "fr": "Épisode",
    "it": "Episodio",
    "ja": "エピソード"
  },
  "_links": {
    "curies": [
      {
        "href": "http://developer.avid.com/ctms/api/relations/linkrels/{rel}.html",
        "name": "relations",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…​"
    },
    "relations:create-relation": {
      "href": "https://host/…​"
    }
  }
}