facets entry

Content Platform Tenant Management Help

File Size
4269 KB
Part Number

You use the facets entry to request summary information for the returned values of specified object properties. For each specified property, HCP returns a list of up to one hundred object property values that occur most frequently in the result set. Each entry in the list has the number of objects that have each of the object property value. For example, if you specify retentionClass in the facets entry, HCP returns a list of up to one hundred retention classes that occur with objects in the result set, along with the number of objects in each of those classes.

Facet object properties

The value of the facets entry is a comma-separated list of one or more of the object properties in the list below. Multiple properties can be specified in any order.

Returns the numbers of objects in the result set that are on hold and not on hold.
Returns the names of namespaces that contain objects in the result set and the number of objects in the result set in each of those namespaces.
For each of these retention values, returns the number of objects in the result set that have that value:
For objects with a retention setting of Initial Unspecified
For objects with a retention setting of Deletion Prohibited
For objects with a retention setting that is Deletion Allowed or a specific date in the past
not expired
For objects with a retention setting that is a specific date in the future
Returns the retention classes that are retention settings for objects in the result set and the number of objects in each retention class.
The count of objects in a retention class can include objects from more than one namespace. This is because multiple namespaces can have retention classes with the same name. To get an accurate count of the objects in a namespace that are in a specific retention class, restrict the query to a single namespace.
For Boolean and string content properties, returns the number of objects with the specified property value. For numeric and date properties, returns the number of objects in ranges of values.
You cannot use tokenized (full-text searchable) content properties with facets.

Content property facet ranges

For numeric and date content properties, you specify the minimum and maximum values (range) for which to return information. You also specify the size of the sub-ranges (the interval) into which to divide the range.

You use the following format to specify the range and interval for facets for content properties with a type of integer, floating point, or date:


In this expression:

  • start-value is inclusive, that is the range includes the specified value.
  • Each entry in the response has an interval that is as close as possible to the specified interval, but not larger than it.
  • end-value is inclusive.
  • The last facet must have a full interval, even if end-value is less than the end of an interval.

For example, if the a facets entry includes a salary content property with a start-value of 10,000, an end-value of 99,999.99 and an interval of 10,000, the response will include ten entries for the property. The first entry will contain the number of employees with salaries of 10,000.00 through 19,999.99, the second will count salaries of 20,000.00 through 29,999.99, and the last will count salaries of 90,000 through 99,999.99.

However, if you specify an end-value of 100,000, the response will include 11 entries. The tenth entry will count salaries of 90,000.00 through 99,999.99, as before, but the response will include an additional entry that counts salaries of 100,000 through 109,999.99, even though you specified only 100,000

For dates:

  • The start-value and end value must be either NOW, for the time when HCP processes the request, or a date-time value in this format:

    The time must be in UTC (coordinated universal time, also known as Greenwich Mean Time), not the local time, and you must specify the letter Z at the end of the format. For example, to specify noon Eastern Standard Time on February 10, 2013, specify 2013-02-10T17:00:00Z

  • Follow these rules when you specify the interval:
    • Specify the time using a number immediately followed by the calendar unit: SECOND, MINUTE, HOUR, DAY, MONTH, YEAR. You can use plurals of these values, for example 2MONTHS.
    • Precede the time interval with a plus sign (+).
    • You can combine intervals, such as +1YEAR+6MONTHS

This example requests facet information for three content properties: salary, dateOfBirth, and zip:


The example consists of these facets:

  • The salary facet requests the number of objects with salaries in the range zero through 999,999.00, broken out into intervals of 50,000.
  • The dateOfBirth facet requests the number of objects with birth dates in each ten-year interval from midnight, January 1, 1900 to now.
  • The zip facet requests the number of objects with each zip code that occurs in the result set. In this example, the zip content property has a type of string, so you cannot specify a range or interval for it. This request returns facets only for zip codes that have at least one matching object.