Resource taxonomies:taxonomies

Overview

The taxonomies:taxonomies resource is the entry point for taxonomy-related functions of a system.

Properties

The taxonomies:taxonomies resource has no properties.

Link Relations

taxonomies:entry-by-taxonomyid-and-entryid

Get an entry of a taxonomy.

taxonomies:taxonomy-by-taxonomyid

Get a taxonomy identified by its id.

taxonomies:taxonomy-list

Get a list of all taxonomies.

Description

The taxonomies:taxonomies resource is the entry point for taxonomy-related functions of a system. You can query the taxonomies:taxonomies resource by getting the service root info (see Service Root Info) and following the taxonomies:taxonomies link.

Query parameter Description

embed

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

  • taxonomy-list: embeds the taxonomies:taxonomy-list resource with the list of all taxonomies in the system.

  • taxonomy: (only if taxonomy-list is also embedded) embeds the taxonomies:taxonomy resources for all taxonomies.

Examples

Example resource 
 
{
  "_links": {
    "curies": [
      {
        "href": "https://developer.avid.com/ctms/api/taxonomies/linkrels/{rel}.html",
        "name": "taxonomies",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…​"
    },
    "taxonomies:taxonomy-list": {
      "href": "https://host/…​"
    },
    "taxonomies:taxonomy-by-taxonomyid": {
      "href": "https://host/…​",
      "templated": true
    },
    "taxonomies:entry-by-taxonomyid-and-entryid": {
      "href": "https://host/…​",
      "templated": true
    }
  }
}