Resource taxonomies:entry

Overview

The taxonomies:entry resource represents an entry of a taxonomy.

Properties

The taxonomies:entry resource has the following properties:

id

The id of the entry

labels

(Optional) Contains a map setting a label for a number of culture codes. Example:

"labels": {
  "en": "Germany",
  "de": "Deutschland"
}

A client should use a language fallback mechanism to find the correct label. For example, for the culture "fr-CA" (Canadian French) the client should try "fr-CA", then "fr", then typically the default fallback language "en". If there’s still no label, the client should use the ID of the entry as label.

tooltips

(Optional) Localized tool tips for the taxonomy entry. The structure is similar to the one for the labels.

attributes

(Optional) An array of attributes of the entry. The attributes may contain additional information about an entry.

The structure of the property follows the structure of the aa:attributes of an asset, but with one extension: the type of an attribute can be "localized <basetype>". The value of a localized attribute is a map that sets a value for a number of culture codes. Examples:

{
  "id": "719",
  "attributes": [
    {
      "name": "scopenote",
      "type": "localized string",
      "value": {
        "en": "Germany (German: Deutschland), officially the Federal Republic of Germany (German: Bundesrepublik Deutschland), is a country in Central and Western Europe, lying between the Baltic and North seas to the north, and the Alps to the south.",
        "de": "Deutschland, offiziell die Bundesrepublik Deutschland, ist ein Land in Zentral- und Westeuropa. Es liegt zwischen der Nord- und Ostsee im Norden und den Alpen im Süden."
      }
    },
    {
      "name": "synonyms",
      "type": "localized multi-value string",
      "value": {
        "en": [
          {
            "index": 0,
            "value": "Federal Republic of Germany"
          }
        ],
        "de": [
          {
            "index": 0,
            "value": "Bundesrepublik Deutschland"
          }
        ]
      }
    }
  ]
}

Here, we have two localized attributes:

  • The attribute "scopenote" of type "localized string". It contains localized strings for the cultures "en" and "de".

  • The attribute "synonyms" of type "localized multi-value string". It contains localized values for the cultures "en" and "de". For each value, it contains an array of string values.

Typical attributes for thesaurus entries of MediaCentral

Link Relations

taxonomies:child-entries

Get the list of child entries for the current entry.

taxonomies:create-child-entry

Create a child entry below the current entry.

taxonomies:delete-entry

Delete the current entry.

taxonomies:parent-entry

Get the parent entry of the current entry.

taxonomies:path-to-root

Get the path that leads to the taxonomy entry.

taxonomies:taxonomy

Get the taxonomy that contains the current entry.

taxonomies:update-entry

Update the current entry.

Description

The taxonomies:entry resource represents an entry of a taxonomy.

Query parameter Description

embed

Sub resources to embed. The value is a comma-separated list with the following values:

Examples

Example Resource 
 
{
  "id": "719",
  "labels": {
    "en": "Germany",
    "de": "Deutschland"
  },
  "attributes": [
    {
      "name": "scopenote",
      "type": "localized string",
      "value": {
        "en": "Germany (German: Deutschland), officially the Federal Republic of Germany (German: Bundesrepublik Deutschland), is a country in Central and Western Europe, lying between the Baltic and North seas to the north, and the Alps to the south.",
        "de": "Deutschland, offiziell die Bundesrepublik Deutschland, ist ein Land in Zentral- und Westeuropa. Es liegt zwischen der Nord- und Ostsee im Norden und den Alpen im Süden."
      }
    },
    {
      "name": "synonyms",
      "type": "localized multi-value string",
      "value": {
        "en": [
          {
            "index": 0,
            "value": "Federal Republic of Germany"
          }
        ],
        "de": [
          {
            "index": 0,
            "value": "Bundesrepublik Deutschland"
          }
        ]
      }
    },
    {
      "name": "attachments",
      "type": "multi-value string",
      "value": [
        {
          "index": 0,
          "value": "https://www.bundesregierung.de"
        },
        {
          "index": 1,
          "value": "https://en.wikipedia.org/wiki/Germany"
        }
      ]
    }
  ],
  "_links": {
    "curies": [
      {
        "href": "https://developer.avid.com/ctms/api/taxonomies/linkrels/{rel}.html",
        "name": "taxonomies",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…​"
    },
    "taxonomies:parent-entry": {
      "href": "https://host/…​"
    },
    "taxonomies:path-to-root": {
      "href": "https://host/…​"
    },
    "taxonomies:child-entries": {
      "href": "https://host/…​"
    },
    "taxonomies:delete-entry": {
      "href": "https://host/…​"
    },
    "taxonomies:update-entry": {
      "href": "https://host/…​"
    },
    "taxonomies:create-child-entry": {
      "href": "https://host/…​"
    },
    "taxonomies:taxonomy": {
      "href": "https://host/…​"
    }
  }
}