Facet value

REST APIs

Content Hub Developer
REST APIs
Facet value

The Facet Resource is a json object that contains the information related to a facet:

Name	Type	Description
properties	Object	A dictionary object containing the properties and values. Properties include a title, an identifier, and optionally: a number of matched results.
add	Search Link	A hyperlink to the resource that represents the search with this facet added.
Entity	Link	A hyperlink to the resource that represents the entity behind this facet value (if any)

Example

{
    "properties": {
        "title": "My Facet Title",
        "matches": 96,
        "identifier": "facet value identifier - could be Redis entity id or Redis definition name or solr field name"
    },
    "add": {
        "query": "myQueryWithFacetValueAddedAsFilter",
        "href": "http://<hostname>/api/search?q=myQueryWithFacetValueAddedAsFilter&skip=10&take=10"
    },
    "Entity": {
        "href": "http://<hostname>/api/entities/entityId"
    }
}

If you have suggestions for improving this article, let us know!