facets entry
The facets
response entry has one or more child facet
entries, as described below.
facet
Child of the
facets
entry. This entry contains theproperty
property and one or morefrequency
entries.property
(property)
Property of the facet entry. The value for this property is one of:
- hold
- namespace
- retention
- retentionClass
- content-property-name
frequency
(child)
Child of the
facet
entry. This entry contains thecount
andvalue
properties.This entry is returned only for property values that appear in the result set.
frequency
entries are listed in descending order based on the value of thecount
property. A query response can contain a maximum of one hundredfrequency
entries.count
(property)
The number of objects in the result set with the
property
value identified by thevalue
property.value
(property)
An object property value that applies to one or more objects in the result set.
The value of this property depends on the
property
value of the parentfacet
entry. When the value of the parentfacet
entryproperty
property is:hold
, this value is eithertrue
orfalse
.retention
, this value is one of:initialUnspecified
For objects with a retention setting of Initial Unspecified
neverDeletable
For objects with a retention setting of Deletion Prohibited
expired
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
retentionClass
, this value is the name of a retention class for an object in the result set.namespace
, this value identifies a namespace that contains an object in the result set. The value has this format:namespace-name.tenant-name
- content-property-name, this value is a value of the named content property that occurs in the result set.