operation entry

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

Except when requesting all available information, the operation entry is required for operation-based queries. It can contain any combination of the entries listed in the table below.

Entry Valid values Description
count

One of:

  • -1, to request all operation records that meet the query criteria
  • A positive integer

Specifies the maximum number of operation records to return per request.

If you omit this entry, HCP returns up to ten thousand operation records per request.

lastResult N/A Specifies the last record returned by the previous query. Use this entry in paged queries to request additional results after an incomplete response. Omit this entry if you are not using a paged query or if this is the first request in a paged query.
objectProperties A comma separated list of object properties.

Requests specific object property values for each object entry in the query results.

If the request body contains both the verbose and objectProperties entries, HCP returns only the object URL, version ID, operation type, and change time and the information specified in the objectProperties entry.

systemMetadata N/A Specifies the properties to use as the query criteria.
verbose

One of:

true
Return all object properties.
false
Return only the object URL, version ID, operation, and change time.

Specifies whether to return complete metadata for each operation record in the result set (true) or to return only the object URL, version ID, operation type, and change time (false).

The default is false.

If the query request body contains both the verbose and objectProperties entries, HCP returns only the object URL, version ID, operation type, and change time and the information specified in the objectProperties entry.