Resource taxonomies:taxonomy-model

Overview

The taxonomies:taxonomy-model resource represents the data model of a taxonomy.

Properties

The taxonomies:taxonomy-model resource has the following properties:

attributes

An array with descriptions of the attributes that each entry of the taxonomy can have. The format of the attribute description is the same as for the datamodel:system-model with one extension:

  • The type property of an attribute can have a sub property localizable. If the value is true, the attribute value is a localizable value. See taxonomies:entry for details.

Link Relations

taxonomies:taxonomy

Get the taxonomy for this model.

Description

The taxonomies:taxonomy-model resource represents the data model of a taxonomy.

Query parameter Description

lang

Requested language code.

  • If given, the model contains labels in the given language, using a language fallback mechanism if necessary.

  • If not given, the model will contain all labels that are defined for the attributes.

Examples

Example MC | Asset Management Thesaurus 
 
{
  "_links": {
    "curies": [
      {
        "href": "http://services.avid.com/apis/taxonomies/{rel}",
        "name": "taxonomies",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…​"
    },
    "taxonomies:taxonomy": {
      "href": "https://host/…​"
    }
  },
  "attributes": [
    {
      "id": "synonyms",
      "labels": {
        "en": "Synonyms",
        "de": "Synonyme"
      },
      "type": {
        "baseType": "string",
        "multiValue": true,
        "localizable": true
      }
    },
    {
      "id": "scopenote",
      "labels": {
        "en": "Scope notes",
        "de": "Scope notes"
      },
      "type": {
        "baseType": "string",
        "localizable": true
      }
    },
    {
      "id": "attachments",
      "labels": {
        "en": "Attachments",
        "de": "Anhänge"
      },
      "type": {
        "baseType": "string",
        "multiValue": true
      }
    }
  ]
}

Example MC | Asset Management Legal list 
 
{
  "_links": {
    "curies": [
      {
        "href": "http://services.avid.com/apis/taxonomies/{rel}",
        "name": "taxonomies",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…​"
    },
    "taxonomies:taxonomy": {
      "href": "https://host/…​"
    }
  },
  "attributes": [
    {
      "id": "index",
      "labels": {
        "en": "Sort index",
        "de": "Sortierungsindex"
      },
      "description": "Sort index",
      "type": {
        "baseType": "int"
      }
    },
    {
      "id": "shortcut",
      "labels": {
        "en": "Shortcut",
        "de": "Kürzel"
      },
      "description": "Shortcut for entry",
      "type": {
        "baseType": "string"
      }
    }
  ]
}

Example MC | Asset Management Master data 
 
{
    "_links": {
        "curies": [
            {
                "href": "http://services.avid.com/apis/taxonomies/{rel}",
                "name": "taxonomies",
                "templated": true
            }
        ],
        "self": {
            "href": "https://host/…​"
        },
        "taxonomies:taxonomy": {
            "href": "https://host/…​"
        }
    },
    "attributes": [
        {
            "id": "ATHLETE_SURNAME",
            "labels": {
                "en": "Surname"
            },
            "type": {
                "baseType": "string",
                "maxLength": 64
            }
        },
        {
            "id": "ATHLETE_FIRSTNAME",
            "labels": {
                "en": "First Name"
            },
            "type": {
                "baseType": "string",
                "maxLength": 64
            }
        },
        {
            "id": "ATHLETE_NATIONALITY",
            "labels": {
                "en": "Nationality"
            },
            "type": {
                "baseType": "thesaurus",
                "thesaurus": "ISO3166-1COUNTRYCODES",
                "taxonomyid": "TH_ISO3166-1COUNTRYCODES"
            }
        },
        {
            "id": "ATHLETE_DISCIPLINE",
            "labels": {
                "en": "Discipline"
            },
            "type": {
                "baseType": "thesaurus",
                "thesaurus": "SPORTS_DISCIPLINES",
                "taxonomyid": "TH_SPORTS_DISCIPLINES"
            }
        },
        {
            "id": "ATHLETE_BIRTHDAY",
            "labels": {
                "en": "Birthday"
            },
            "type": {
                "baseType": "date"
            }
        },
        {
            "id": "ATHLETE_BIRTHPLACE",
            "labels": {
                "en": "Birthplace"
            },
            "type": {
                "baseType": "string",
                "maxLength": 64
            }
        },
        {
            "id": "ATHLETE_GENDER",
            "labels": {
                "en": "Gender"
            },
            "type": {
                "baseType": "list",
                "list": "GENDER",
                "taxonomyid": "LL_GENDER"
            }
        },
        {
            "id": "ATHLETE_WEIGHT",
            "labels": {
                "en": "Weight"
            },
            "type": {
                "baseType": "float",
                "preDecimalPlaces": 3,
                "decimalPlaces": 2
            }
        },
        {
            "id": "ATHLETE_HEIGHT",
            "labels": {
                "en": "Height"
            },
            "type": {
                "baseType": "int",
                "digits": 5
            }
        },
        {
            "id": "ATHLETE_REPRESENTATIVE",
            "labels": {
                "en": "Representative"
            },
            "type": {
                "baseType": "string",
                "maxLength": 128
            }
        },
        {
            "id": "SYSTEM_OWNERS",
            "labels": {
                "en": "System System Owners"
            },
            "type": {
                "baseType": "string",
                "multiValue": true,
                "maxLength": 64
            }
        }
    ]
}