Resource taxonomies:path-to-root

Overview

The taxonomies:path-to-root resource represents the path that leads to a taxonomy entry, from the top-level entry to the direct parent entry.

Properties

The taxonomies:path-to-root resource has no properties.

Link Relations

taxonomies:path (multi-link)

Get the taxonomy entries (type taxonomies:entry) that make up the path.

Description

The taxonomies:path-to-root resource represents the path that leads to a taxonomy entry, from the top-level entry to the direct parent entry.

It can be used to track breadcrumbs of a taxonomy entry. taxonomies:path-to-root contains an array of taxonomies:path links, pointing to the taxonomies:entry entries that make up the path. The array lists the entries from the top-level entry (index 0) to the next enclosing parent (index n).

Query parameter Description

embed

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

Examples

Example resource for the entry 'Germany' (which is under '/World/Europe/Central Europe' in the thesaurus) using '?embed=path' to embed the taxonomies entries of the path in the response 
 
{
  "_links": {
    "curies": [
      {
        "href": "https://developer.avid.com/ctms/api/taxonomies/linkrels/{rel}.html",
        "name": "taxonomies",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…​"
    },
    "taxonomies:path": [
      {
        "href": "https://host/…​",
        "title": "World"
      },
      {
        "href": "https://host/…​",
        "title": "Europe"
      },
      {
        "href": "https://host/…​",
        "title": "Central Europe"
      }
    ]
  },
  "_embedded": {
    "taxonomies:path": [
      {
        "id": "532",
        "labels": {
          "en": "World"
        },
        "_links": {
          "self": {
            "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/…​"
          }
        }
      },
      {
        "id": "712",
        "labels": {
          "en": "Europe"
        },
        "_links": {
          "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/…​"
          }
        }
      },
      {
        "id": "717",
        "labels": {
          "en": "Central Europe"
        },
        "_links": {
          "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/…​"
          }
        }
      }
    ]
  }
}