Resource relations:relation

New in MC | Cloud UX 2019.5

Overview

The relations:relation resource represents a relation of an aa:asset to another aa:asset.

Theoretically, a loc:item can also have relations to other items or assets, but that is currently not supported by any system type.

Properties

The relations:relation resource has the following properties:

relationType

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

relatedEntity

Detailed information about the related asset:

  • kind: "aa" if the related entity is an asset, "loc" if the related entity is a location item (currently not supported).

  • id: ID of the related asset or location

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

labels

Labels for the relation type. If the query parameter lang is given, only the label for that language is returned, otherwise the labels for all languages are returned.

The labels are the same as the ones returned by relations:relation-types or relations:relation-type.

Link Relations

relations:relation-type

Link to the definition of the relation type.

relations:related-entity

A link to the related asset or location item.

relations:delete-relation

Delete the relation.

Examples

Example: A relation of an asset in MediaCentral | Asset Management. 
 
{
   "relationType": "VIDEO_IMAGE.forward",
   "relatedEntity": {
      "id": "20191024113124801012915624400505687C1FF0000003548B00000D0D000007",
      "kind": "aa",
      "type": "IMAGE"
   },
   "labels": {
      "en": "Image"
   },
   "_links": {
      "curies": [
         {
            "href": "http://developer.avid.com/ctms/api/relations/linkrels/{rel}.html",
            "name": "relations",
            "templated": true
         }
      ],
      "self": {
         "href": "https://host/…​"
      },
      "relations:delete-relation": {
         "href": "https://host/…​"
      },
      "relations:related-entity": {
         "href": "https://host/…​"
      },
      "relations:relation-type": {
         "href": "https://host/…​"
      }
   }
}