Resource taxonomies:hit-list

New in MC | Cloud UX 2022.3

Overview

Definition of a recommended hit list format when showing entries of a taxonomy. The value can be used when showing a full list of entries (see taxonomies:entries) or when showing the matching hits of a search for taxonomy entries (see taxonomies:search).

Properties

The taxonomies:hit-list resource has the following properties:

base

The id quadruple of the taxonomy. Example:

  "base": {
    "systemType": "interplay-mam",
    "systemID": "324394-234-3243432",
    "type": "masterdata",
    "id": "MD_MA_MASTER_ATHLETES"
  }

columns

Array of hit-list columns that a client should show. Example:

  "columns": [
    {
      "columnType": "id",
      "width": 120
    },
    {
      "columnType": "label"
    },
    {
      "columnType": "attribute",
      "attribute": "ATHLETE_FIRSTNAME",
      "width": 120
    }
  ]

For each column, the following properties are supported:

Property Description

columnType

Type of the column. One of:

  • id: ID of the entry.

  • label: Localized label for the entry.

  • attribute: An attribute of the taxonomy entry.

For MC | AM master data taxonomies, all columns are of columnType attribute.

attribute

Only for columnType=attribute: The attribute to show in this column.

width

(Optional) Recommended width of the column in pixels.

sort

(Optional) Recommended default sort order. The value is a string that can be used directly as query parameter sort when calling taxonomies:entries or taxonomies:search.

The value is a comma-separated list of sort specs, each consisting of an optional prefix (+=ascending, -=descending), followed by an attribute ID. Example:

  "sort": "ATHLETE_SURNAME,ATHLETE_FIRSTNAME,-ATHLETE_BIRTHDAY"

This sorts primarily by surname in ascending order, then by first name in ascending order, then by birthday in descending order.

Link Relations

taxonomies:taxonomy

Get the taxonomy for this hit-list.

Example

Hit-list definition for an MC|AM master data taxonomy 
 
{
    "base": {
        "id": "MD_MA_MASTER_ATHLETES",
        "type": "masterdata",
        "systemType": "interplay-mam",
        "systemID": "18046458-EE19-4F42-80F3-47C8A977C688"
    },
    "sort": "ATHLETE_SURNAME",
    "columns": [
        {
            "columnType": "attribute",
            "attribute": "ATHLETE_SURNAME",
            "width": 160
        },
        {
            "columnType": "attribute",
            "attribute": "ATHLETE_FIRSTNAME",
            "width": 160
        },
        {
            "columnType": "attribute",
            "attribute": "ATHL_TEXT_UNLIMITED",
            "width": 60
        },
        {
            "columnType": "attribute",
            "attribute": "ATHLETE_NATIONALITY",
            "width": 80
        },
        {
            "columnType": "attribute",
            "attribute": "ATHLETE_DISCIPLINE",
            "width": 160
        }
    ],
    "_links": {
        "curies": [
            {
                "href": "http://developer.avid.com/ctms/api/taxonomies/linkrels/{rel}.html",
                "name": "taxonomies",
                "templated": true
            }
        ],
        "self": {
            "href": "https://host/…​"
        },
        "taxonomies:taxonomy": {
            "href": "https://host/…​"
        }
    }
}