object entry
The object entry is required for object-based requests. It must contain the query
entry and can contain any combination of the other entries listed in the table below.
Entry | Valid values | Description |
query | A query expression | Specifies the query criteria. This entry is required. |
content Properties |
One of:
|
Returns information about the content properties available for use in queries. The default is To return only content properties, specify a |
count |
One of:
• |
Specifies the maximum number of results to return. If you omit this entry, HCP returns a maximum of one hundred results. HCP responds significantly faster to a request for all results when the request is for basic information only (that is, the value of the |
facets |
A comma-separated list of zero or more of:
|
Requests summary information for the returned values of the specified object properties. The values for this entry are case sensitive. |
object Properties | A comma-separated list of object properties |
Requests specific object properties to return for each All object entries include the If you specify this property, any |
offset | An integer between zero and 100,000 |
Skips the specified number of object entries in the complete result set. Specify this entry when you’re performing a paged query. The default is zero. |
sort | A comma-separated list of object properties and content properties with optional sort-order indicators | Specifies the sort order for object entries in the result set. |
verbose |
One of:
|
Specifies whether to return complete metadata for each object in the result set ( The default is If the request body contains both this property and the |