Resource taxonomies:taxonomy

Overview

The taxonomies:taxonomy resource represents a taxonomy on the Avid platform.

Properties

The taxonomies:taxonomy resource has the following properties:

base	The base identifiers of the taxonomy. The property is a JSON object with the following sub properties: systemType: Type of the taxonomy’s source system systemID: Id of the taxonomy’s source system type: type of the taxonomy id: Id of the taxonomy in the source system
labels	(Optional) Contains a map setting a label for a number of culture codes. Example: `"labels": { "en-US": "Countries", "en-UK": "Countries", "en": "Countries", "de": "Länder" }` 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 taxonomy as label.
tooltips	(Optional) Specifies localized tool tips for the taxonomy. The structure is similar to the one for labels.
attributes	(Optional) A set of attributes of the taxonomy. Currently, the following attributes are supported: defaultEntry: (optional, string) The ID of the default entry. This entry can be displayed, for example, as default value for a taxonomy attribute when creating a new asset. showIcons: (optional, boolean) True, if the values of this taxonomy are supposed to be displayed as icons in a UI. Example (abbreviated): `{ "base": { "id": "LL_AVID_RIGHTS_INDICATORS", "type": "list", "systemType": "interplay-mam", "systemID": "8967452d-f282-430e-8aec-7b42a7872019" }, "labels": { ... }, "attributes": [ { "name": "defaultEntry", "value": "2" }, { "name": "showIcons", "value": true } ], "_links": { ... } }` The attributes can be changed using the taxonomies:update-taxonomy link relation.

base

The base identifiers of the taxonomy. The property is a JSON object with the following sub properties:

systemType: Type of the taxonomy’s source system
systemID: Id of the taxonomy’s source system
type: type of the taxonomy
id: Id of the taxonomy in the source system

labels

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

"labels": {
  "en-US": "Countries",
  "en-UK": "Countries",
  "en": "Countries",
  "de": "Länder"
}

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 taxonomy as label.

tooltips

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

attributes

(Optional) A set of attributes of the taxonomy. Currently, the following attributes are supported:

defaultEntry: (optional, string) The ID of the default entry. This entry can be displayed, for example, as default value for a taxonomy attribute when creating a new asset.
showIcons: (optional, boolean) True, if the values of this taxonomy are supposed to be displayed as icons in a UI.

Example (abbreviated):

{
  "base": {
    "id": "LL_AVID_RIGHTS_INDICATORS",
    "type": "list",
    "systemType": "interplay-mam",
    "systemID": "8967452d-f282-430e-8aec-7b42a7872019"
  },
  "labels": { ... },
  "attributes": [
    {
      "name": "defaultEntry",
      "value": "2"
    },
    {
      "name": "showIcons",
      "value": true
    }
  ],
  "_links": { ... }
}

The attributes can be changed using the taxonomies:update-taxonomy link relation.

Link Relations

taxonomies:create-entry-bulk	Create a set of entries in the taxonomy.
taxonomies:create-entry	Create a top-level entry in the taxonomy.
taxonomies:create-or-update-entry-bulk	Create or update multiple entries of the taxonomy.
taxonomies:create-or-update-entry	Create or update an entry of the taxonomy.
taxonomies:default-entry	(Optional Link Relation) Get the default entry.
taxonomies:entries	Get the list of top-level entries of the taxonomy.
taxonomies:entry-by-entryid-bulk	Get the entries with the given IDs.
taxonomies:entry-by-entryid	Get the entry with the given ID.
taxonomies:hit-list	Get a recommended hit-list format for the taxonomy.
taxonomies:move-entry	(Optional Link Relation) Move an entry of the taxonomy.
taxonomies:search	Find taxonomy entries that match a given search condition.
taxonomies:taxonomy-model	(Optional Link Relation) Get the Meta data model for the taxonomy.
taxonomies:update-entry-bulk	Update a set of entries of the taxonomy.
taxonomies:update-taxonomy	(Optional Link Relation) Update properties of the taxonomy.

taxonomies:create-entry-bulk

Create a set of entries in the taxonomy.

taxonomies:create-entry

Create a top-level entry in the taxonomy.

taxonomies:create-or-update-entry-bulk

Create or update multiple entries of the taxonomy.

taxonomies:create-or-update-entry

Create or update an entry of the taxonomy.

taxonomies:default-entry

(Optional Link Relation) Get the default entry.

taxonomies:entries

Get the list of top-level entries of the taxonomy.

taxonomies:entry-by-entryid-bulk

Get the entries with the given IDs.

taxonomies:entry-by-entryid

Get the entry with the given ID.

taxonomies:hit-list

Get a recommended hit-list format for the taxonomy.

taxonomies:move-entry

(Optional Link Relation) Move an entry of the taxonomy.

taxonomies:search

Find taxonomy entries that match a given search condition.

taxonomies:taxonomy-model

(Optional Link Relation) Get the Meta data model for the taxonomy.

taxonomies:update-entry-bulk

Update a set of entries of the taxonomy.

taxonomies:update-taxonomy

(Optional Link Relation) Update properties of the taxonomy.

Description

The taxonomies:taxonomy resource represents a taxonomy on the Avid platform.

The taxonomies:taxonomy link in the CTMS Registry supports the following query parameters:

Query parameter	Description
embed	Sub resources to embed. The value is a comma-separated list with the following values: entries: embeds the taxonomies:entries resource with the first page of top-level entries. entry: embeds the taxonomies:entries resource with the first page of top-level entries and the taxonomies:entry resources of the entries in that list. default-entry: embeds the taxonomies:entry resource with the default entry, if the taxonomy supports default entries and and entry is defined as default entry taxonomy-model: embeds the taxonomies:taxonomy-model resource with the data model of the taxonomy.

Query parameter

Description

embed

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

entries: embeds the taxonomies:entries resource with the first page of top-level entries.
entry: embeds the taxonomies:entries resource with the first page of top-level entries and the taxonomies:entry resources of the entries in that list.
default-entry: embeds the taxonomies:entry resource with the default entry, if the taxonomy supports default entries and and entry is defined as default entry
taxonomy-model: embeds the taxonomies:taxonomy-model resource with the data model of the taxonomy.

You can get a taxonomies:taxonomy resource like this:

Query the CTMS registry
Find the link taxonomies:taxonomy-by-taxonomyid for the system you want to query.
Replace the URI template parameter "taxonomyid" with the ID of the taxonomy you want to query.
Call GET on the URI.

There are different kinds of taxonomies. Some taxonomies consist of a flat list of entries, others are organized hierarchical as a tree of entries. The term "top-level entries" in this documentation means all entries in case of flat taxonomies, and the root entries for hierarchical taxonomies.

Examples

Example Resource

 
{
  "base": {
    "id": "LL_AVID_RIGHTS_INDICATORS",
    "type": "list",
    "systemType": "interplay-mam",
    "systemID": "8967452d-f282-430e-8aec-7b42a7872019"
  },
  "labels": {
    "ar": "مؤشرات الحقوق",
    "de": "Rechteanzeige",
    "en": "Rights Indicators",
    "en-AU": "Rights Indicators",
    "es": "Indicadores de derechos",
    "fr": "Indicateurs de droits",
    "it": "Indicatori diritti",
    "ja": "権限インジケーター",
    "ko": "권한 인디케이터",
    "pl": "Wskaźniki praw",
    "pt": "Indicadores Direitos",
    "ru": "Указатели прав",
    "tr": "Hak Göstergeleri",
    "zh": "权限指示器"
  },
  "attributes": [
    {
      "name": "defaultEntry",
      "value": "2"
    },
    {
      "name": "showIcons",
      "value": true
    }
  ],
  "_links": {
    "curies": [
      {
        "href": "https://developer.avid.com/ctms/api/taxonomies/linkrels/{rel}.html",
        "name": "taxonomies",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…"
    },
    "taxonomies:create-or-update-entry": {
      "href": "https://host/…"
    },
    "taxonomies:create-entry": {
      "href": "https://host/…"
    },
    "taxonomies:update-taxonomy": {
      "href": "https://host/…"
    },
    "taxonomies:entry-by-entryid": {
      "href": "https://host/…",
      "templated": true
    },
    "taxonomies:entry-by-entryid-bulk": {
      "href": "https://host/…"
    },
    "taxonomies:entries": {
      "href": "https://host/…"
    },
    "taxonomies:search": {
      "href": "https://host/…"
    },
    "taxonomies:taxonomy-model": {
      "href": "https://host/…"
    },
    "taxonomies:default-entry": {
      "href": "https://host/…"
    }
  }
}