Content Delivery API

Taxonomy

Taxonomy concepts on entries and assets

Concept

Get a concept

Returns a single concept based on the given identifier.

Concept collection

Get all concepts

Returns all the concepts that exist in a given organization.

Filters

There are following filters available on this endpoint:

FilterDescription
limitLimits the maximum number of concepts returned (per page)
pageNextPagination cursor from which to return the next page of concepts. Alternatively, just call the url at pages.next in the previous response
pagePrevPagination cursor from which to return the previous page of concepts. Alternatively, just use the full url from pages.prev in the previous response
orderReturns results ordered by the value specified. Supports sys.updatedAt, sys.createdAt, prefLabel
conceptSchemeReturn only concepts belonging to the specified concept scheme

Concept Scheme

Get a concept scheme

Returns a single concept scheme based on the given identifier.

Concept collection schemes

Get all concepts

Returns all the concepts schemes that exist in a given organization.

Taxonomy concepts on entries and assets

Note:

  • Entry and Asset payloads come with a metadata property. This metadata property has as its value a concepts list. The concept list contains links to all the concepts that exist on the entry or asset.
  • You can query for entries by their concepts. The search is across content types.

Use the Get an entry endpoint.

Returns a single entry or asset with a metadata property. The metadata property holds a list of taxonomy concepts.

Querying content based on a set of concepts

The query parameter starts with metadata.concepts.sys.id with operator [all].

To retrieve entries or assets that match a set of concepts values, use the Get all entries of a Space endpoint, see example:

/spaces/yadj1kx9rmg0/environments/staging/entries?metadata.concepts.sys.id[all]=3kZdDUXy9n0l2Xi2cq8TPc

Returns a list of entries or assets according to one or more of the specified concept IDs.

Querying content based on one or more concepts

The query parameter starts with metadata.concepts.sys.id with operator [in].

To retrieve entries or assets that match at least one of the specified concepts values, use the Get all entries of a Space endpoint, see example:

/spaces/yadj1kx9rmg0/environments/staging/entries?metadata.concepts.descendants[in]=3kZdDUXy9n0l2Xi2cq8TPc

Returns a list of entries according to the specified set of concept IDs.

Querying content based on one or more concepts and their descendants

The query parameter starts with metadata.concepts.descendants with operator [in].

To retrieve entries or assets that match at least one of the specified concepts values or their descendants, use the Get all entries of a Space endpoint, see example:

/spaces/yadj1kx9rmg0/environments/staging/entries?metadata.concepts.descendants[in]=3kZdDUXy9n0l2Xi2cq8TPc

Returns a list of entries according to the specified set of concept IDs and their descendant concepts.