Overview
The taxonomies:entries resource represents a list of entries in a taxonomy.
Properties
The taxonomies:entries resource has the following properties:
paging |
Paging information. See paging for details. |
|---|
Link Relations
prev, next, first |
Link relations for paging. See paging for details. |
|---|---|
Link to the taxonomy entries in the current page of the list. There can be a single link or an array of links. The same list of entries is automatically added as embedded resources. |
Description
The taxonomies:entries resource represents a list of entries in a taxonomy.
The resource is used for multiple purposes:
-
The taxonomies:entries link in taxonomies:taxonomy: returns the list of top-level entries of a taxonomy.
-
The taxonomies:search link in taxonomies:taxonomy: returns the list of entries that match the given search condition.
-
The taxonomies:child-entries link in taxonomies:entry: returns the list of child entries of an entry.
The resource supports paging.
See Paging Query Parameters for details on the query parameters for paging.
See Paging Properties for details on the paging properties.
Examples
Example that contains the first two child entries of a thesaurus entry. It was limited to 2 entries per result page with the query parameter '?limit=2'
{
"paging": {
"elements": 2,
"totalElements": 16,
"limit": 2,
"offset": 0
},
"_links": {
"curies": [
{
"href": "https://developer.avid.com/ctms/api/taxonomies/linkrels/{rel}.html",
"name": "taxonomies",
"templated": true
}
],
"self": {
"href": "https://host/…"
},
"first": {
"href": "https://host/…"
},
"next": {
"href": "https://host/…"
},
"range": {
"href": "https://host/…",
"templated": true
},
"taxonomies:entry": [
{
"href": "https://host/…"
},
{
"href": "https://host/…"
}
]
},
"_embedded": {
"taxonomies:entry": [
{
"id": "2515",
"labels": {
"en": "Bavaria",
"de": "Bayern"
},
"_links": {
"self": {
"href": "https://host/…"
},
"taxonomies:parent-entry": {
"href": "https://host/…"
},
"taxonomies:delete-entry": {
"href": "https://host/…"
},
"taxonomies:update-entry": {
"href": "https://host/…"
},
"taxonomies:create-child-entry": {
"href": "https://host/…"
},
"taxonomies:taxonomy": {
"href": "https://host/…"
}
}
},
{
"id": "2516",
"labels": {
"en": "Berlin",
"de": "Berlin"
},
"_links": {
"self": {
"href": "https://host/…"
},
"taxonomies:parent-entry": {
"href": "https://host/…"
},
"taxonomies:delete-entry": {
"href": "https://host/…"
},
"taxonomies:update-entry": {
"href": "https://host/…"
},
"taxonomies:create-child-entry": {
"href": "https://host/…"
},
"taxonomies:taxonomy": {
"href": "https://host/…"
}
}
}
]
}
}