systemMetadata entry

Content Platform Tenant Management Help

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

The systemMetadata entry specifies the criteria that the returned operation records must match. The entry contains the child entries listed in the table below. Some of the subentries, such as changeTime, have children. In this table, the parent entries are immediately followed by their children.

Entry Valid values Description
changeTime N/A

Specifies the range of change times of the objects for which to return operation records. This entry can contain neither, one, or both of the start and end child entries.

If you omit this entry, HCP returns operation records for objects with change times between January 1, 1970, at 00:00:00 UTC and one minute before the time HCP received the request.

start(child)

One of:

  • Milliseconds since January 1, 1970, 00:00:00 UTC.
  • An ISO 8601 datetime value in this format:

    yyyy-MM-ddThh:mm:ssZ

    Z represents the offset from UTC, in this format:

    (+|-)hhmm

    For example, 2011-11-16T14:27:20-0500 represents the start of the 20th second into 2:27 PM, November 16, 2011, EST.

Requests operation records for objects with change times on or after the specified date and time. This entry is a child entry of the changeTime entry.

The default is zero (January 1, 1970, 00:00:00 UTC).

In the ISO 8601 format, you cannot specify a millisecond value. The time corresponds to zero milliseconds into the specified second.

end(child)

One of:

  • Milliseconds since January 1, 1970, 00:00:00 UTC
  • An ISO 8601 datetime value in this format:

    yyyy-MM-ddThh:mm:ssZ

Requests operation records for objects with change times before the specified date and time. This entry is a child entry of the changeTime entry.

The default value is one minute before the time HCP received the request.

In the ISO 8601 format, you cannot specify a millisecond value. The time corresponds to zero milliseconds into the specified second.

If you specify a value that is less than one minute before the current time, ensure that all writes finished at least one minute ago so that you get results for the most recent operations.

directories N/A

Specifies the directories to query. This entry contains zero or more directory entries.

If you omit this entry, HCP returns operation records for objects in all directories in the specified namespaces.

directory(child)

The path to the directory containing the objects for which to retrieve operation records.

Start the path with a forward slash (/) followed by the name of a directory immediately below

rest, data, or fcfs_data. Do not include rest, data, or fcfs_data in the path.

Specifies a directory to query. This entry is a child of the directories entry.

If you query multiple namespaces, HCP returns operation records for the directory contents in each namespace in which the directory occurs.

indexable

One of:

true
Return operation records only for objects with an index setting of true.
false
Return operation records only for objects with index setting of false.

Specifies whether to filter the returned operation records based on the object index setting.

HCP returns deletion and purge records only for objects that had the specified setting at the time they were deleted or purged.

If you omit this entry, HCP returns operation records for objects regardless of their index settings.

namespaces N/A

Specifies the namespaces to query. This entry contains zero or more namespace entries.

If the URL in the request starts with default, you can omit this entry. The URL itself limits the query to the default namespace.

If you omit this entry and the URL starts with admin, HCP returns operation records for the default namespace and the namespaces owned by each tenant that has granted system-level users administrative access to itself.

If you omit this entry and the URL starts with a tenant name, HCP returns operation records for the tenant's namespaces that the user has permission to search.

namespace

(child)

A namespace name along with the name of the owning tenant, in this format:

namespace-name.tenant-name

Specifies a namespace to query. This entry is a child of the namespaces entry.

replication

Collsion

One of:

true
Return operation records only for objects that are flagged as replication collisions.
false
Return operation records only for objects that are not flagged as replication collisions.

Specifies whether to filter the returned operation records based on whether the object is flagged as a replication collision.

HCP returns deletion and purge records only for objects that were flagged as replication collisions at the time they were deleted or purged.

If you omit this entry, HCP returns operation records for objects regardless of whether they are flagged as replication collisions.

transactions N/A

Specifies the operation types for which to query. This entry contains up to five transaction entries, each specifying a different operation type.

If you omit this entry, HCP returns records only for create, delete, and purge operations.

transaction(child)

One of:

  • create
  • delete
  • dispose
  • prune
  • purge

Specifies a type of operation for which to return records. This entry is a child entry of the transactions entry.

HCP returns prune and disposition records only when you explicitly request them.

Objects in the default namespace don’t have prune or purge operation types.