Products

AbstractBadge

object
customstring

Image URL with placeholders for {width} and {height}.

hex_colorstring

The hexadecimal color code for this badge.

originalstring

Full size image.

stackstring

Image URL with a placeholder for a Rokka {stack}.

vectorstring

Vector image.

Example

AbstractCollection

A generic collection of elements.

AbstractFacetedSearchResultCollection

object

A collection of search result instances with facets.

idsarray[string]

Ids only.

Is filled instead of the usual property for content, with only the ids when a call is made with verbosity=id on a
route that supports it.

total_hitsinteger

The total hits may exceed the actual count of results in the collection.

It represents the total number of results of a search and not only the
potentially paginated subset.

facetsobjectDEPRECATED

Facets array.

Example

AbstractSearchResultCollection

object

A collection of search result instances.

idsarray[string]

Ids only.

Is filled instead of the usual property for content, with only the ids when a call is made with verbosity=id on a
route that supports it.

total_hitsinteger

The total hits may exceed the actual count of results in the collection.

It represents the total number of results of a search and not only the
potentially paginated subset.

Example

Additive

object

An additive with its level of containment.

codestringrequired

Descriptive label.

containment_codestring
containment_labelstring
labelstringrequired
Example