List facets on a node
GET {{baseUrl}}/v2/facets/:id?where_facet=in laboris magna&where_facet=in&top_values_limit=in laboris magna&top_values_limit=in&facet_id=-11141396&suppress_response_codes=irure labore Duis dolor ea
Gets facet information for the specified node ID.
NOTE: If the node is a Virtual Folder the facets used to generate this object will be returned by default.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
where_facet | string | Specify facets that will alter the available facets for this node using the following syntax: <br>{facetID}:{value1} | |
where_facet | string | Specify facets that will alter the available facets for this node using the following syntax: <br>{facetID}:{value1} | |
top_values_limit | string | Limit the number of available facet values to the top values only (ie. maximum values to display).<br><br> If specified with a value (ie. top_values_limit=5), the number of returned facet values will be set to that.<br><br> If specified without a value (ie. top_values_limit), then the default maximum values to display (as configured on Content Server) will be used.<br><br>NOTE: Relative date facets such as 'Modified Date' are not affected by this parameter at all, also selected facets are similarly unaffected | |
top_values_limit | string | Limit the number of available facet values to the top values only (ie. maximum values to display).<br><br> If specified with a value (ie. top_values_limit=5), the number of returned facet values will be set to that.<br><br> If specified without a value (ie. top_values_limit), then the default maximum values to display (as configured on Content Server) will be used.<br><br>NOTE: Relative date facets such as 'Modified Date' are not affected by this parameter at all, also selected facets are similarly unaffected | |
facet_id | number | Limit the output of the available facets and their values to the specified facet ID(s). This can be specified multiple times (ex. ?facet_id=5880&facet_id=5885)<br><br>NOTE: results.data.facets will always show the selected facet(s) (if any). | |
suppress_response_codes | string | Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).<br><br>NOTE: This parameter does not require a value, so it should be specified as <ul><li><b>[Query String]:</b><code>?suppress_response_codes</code></li><li><b>[Form Body (where the value is an empty string)]</b>: <code>suppress_response_codes = </code></li></ul> |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":[{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}],"results":[{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}]}