Resource relations:relations

New in MC | Cloud UX 2019.5

Overview

The relations:relations resource represents the relations of an aa:asset to other assets.

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:relations resource has the following properties:

paging

Paging information. See paging for details.

assetCount

New in MC | Cloud UX 2023.12 Returns the total number of related assets per relation type. The property is only returned when asked for with the query parameter insist=assetCount.

Link Relations

relations:relation (multi-link)

An array of link rels, one for each relation to other assets. The information about the relations is automatically returned as embedded sub resources.

Examples

Example: relations of an asset in MediaCentral | Asset Management 
 
{
   "paging": {
      "elements": 2,
      "totalElements": 2,
      "limit": 100,
      "offset": 0
   },
   "assetCount": {
      "VIDEO_IMAGE.forward": 1,
      "VIDEO_VIDEO.forward": 1
   },
   "_links": {
      "curies": [
         {
            "href": "http://developer.avid.com/ctms/api/relations/linkrels/{rel}.html",
            "name": "relations",
            "templated": true
         }
      ],
      "self": {
         "href": "https://host/…​"
      },
      "relations:relation": [
         {
            "href": "https://host/…​"
         },
         {
            "href": "https://host/…​"
         }
      ]
   },
   "_embedded": {
      "relations:relation": [
         {
            "relationType": "VIDEO_IMAGE.forward",
            "relatedEntity": {
               "id": "20191024113124801012915624400505687C1FF0000003548B00000D0D000007",
               "kind": "aa",
               "type": "asset.IMAGE"
            },
            "labels": {
               "en": "Image"
            },
            "_links": {
               "self": {
                  "href": "https://host/…​"
               },
               "relations:delete-relation": {
                  "href": "https://host/…​"
               },
               "relations:related-entity": {
                  "href": "https://host/…​"
               },
               "relations:relation-type": {
                  "href": "https://host/…​"
               }
            }
         },
         {
            "relationType": "VIDEO_VIDEO.forward",
            "relatedEntity": {
               "id": "20200124142641001012915624400505687C1FF0000007204B00000D0D000016",
               "kind": "aa",
               "type": "asset.VIDEO"
            },
            "labels": {
               "en": "Video"
            },
            "_links": {
               "self": {
                  "href": "https://host/…​"
               },
               "relations:delete-relation": {
                  "href": "https://host/…​"
               },
               "relations:related-entity": {
                  "href": "https://host/…​"
               },
               "relations:relation-type": {
                  "href": "https://host/…​"
               }
            }
         }
      ]
   }
}