Properties for advanced queries with the metadata query engine

The table below presents the properties you can use in advanced queries while the metadata query engine is active. For each property, the table shows the case-sensitive property name, the data type, a description, an example, and the equivalent structured search property, if any. For information about specifying datetime values, see Specifying dates.

Note: You cannot use $now for datetime values in advanced queries.

Property Data type Description Example Structured query equivalent
accessTime

Long

The value of the POSIX atime attribute for the object, in seconds since January 1, 1970 at 00:00:00 UTC.

accessTime:[1312156800
TO 1312243200]

Access Time

accessTime
String
1

Datetime

The value of the POSIX atime attribute for the object, in ISO 8601 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 20th second into 2:27 PM, November 16, 2011, EST.

accessTimeString:
[2011-08-01T00:00:00-0400
TO
2011-08-02T00:00:00-0400]

N/A

acl2

Boolean

An indication of whether the object has an ACL. Valid values are:

true — The object has an ACL.

false — The object does not have an ACL.

This value is always false for objects in the default namespace.

acl:true

ACL

aclGrant2

String

ACL content.

For information about the values you can specify for this property and examples of advanced queries that specify this property, see aclGrant property.

aclGrant:"Ww,USER,
europe,rsilver"

Grant

changeTime
 Milliseconds

String

The time at which the object last changed. For delete, dispose, prune, and purge records, this is the time when the operation was performed on the object.

The value is the time in milliseconds since January 1, 1970, at 00:00:00 UTC, followed by a period and a two-digit suffix. The suffix ensures that the change times for versions of an object are unique.

This property corresponds to the POSIX ctime attribute for the object.

changeTimeMilliseconds:
[1311206400.00 TO
1311292800.00]

Change
Time

changeTime
String
1

Datetime

The time at which the object last changed in ISO 8601 format:

YYYY-MM-DDThh:mm:ssZ

For more information about this format, see the description of the accessTimeString property.

This property corresponds to the POSIX ctime attribute for the object.

changeTimeString:
[2011-07-21T00:00:00-0400
TO
2011-07-22T00:00:00-0400]

N/A

custom
Metadata
2

Boolean

An indication of whether the object has custom metadata. Valid values are:

true — The object has custom metadata.

false — The object does not have custom metadata.

customMetadata:true

Custom
Metadata

custom
Metadata
Annotation

String

One or more comma-delimited annotation names. Annotation names are case-sensitive.

customMetadataAnnotation:
EasternRegion

Custom
Metadata
Annotation

custom
Metadata
Content3

String

Custom metadata content.

For information about the values you can specify for this property and examples of advanced queries that use this property, see customMetadataContent property.

customMetadataContent:
city.Bath.city

Custom
Metadata
Content

dpl

Integer

The DPL for the object.

dpl:2

N/A

hash

String

The cryptographic hash algorithm used to compute the hash value of the object, followed by a space and the hash value of the object.

The values you specify for both hash algorithms and values are case sensitive. You need to use uppercase letters when specifying these values.

If you do not specify wildcard characters in the value for this property, you need to enclose the entire value for this property in double quotation marks.

When using wildcard characters with this object property, instead of a space, separate the hash algorithm and the hash value with a wildcard character. In this case, do not enclose the value for this property in double quotation marks.

hash:"SHA-2569B6D8A603659B447..."

Hash

hashScheme3

String

The cryptographic hash algorithm the namespace uses.

The value you specify for this property is case sensitive. Do not enclose this value in quotation marks.

hashScheme:SHA-256

N/A

hold2

Boolean

An indication of whether the object is currently on hold. Valid values are:

true — The object is on hold.

false — The object is not on hold.

hold:false

Retention
  Hold

index2

Boolean

An indication of which parts of the object are indexed. Valid values are:

true — All metadata, including any custom metadata and ACL, is indexed.

false — Only system metadata and ACLs are indexed.

index:true

N/A

ingestTime

Long

The time at which HCP stored the object, in seconds since January 1, 1970, at 00:00:00 UTC.

ingestTime:[1309478400
TO 1312156800]

Ingest Time

ingestTime
String
1

Datetime

The time at which HCP stored the object, in ISO 8601 format:

YYYY-MM-DDThh:mm:ssZ

For more information about this format, see the description of the accessTimeString property.

ingestTimeString:
[2011-07-01T00:00:00-0400
TO
2011-07-02T00:00:00-0400]

N/A

namespace

String

The name of the namespace that contains the object, in this format:

namespace-name.tenant-name

The values you specify for this property are not case sensitive.

namespace:finance.europe

Namespace

objectPath3

String

The path to the object following rest, data, or fcfs_data.

The values you specify for this property are not case sensitive and do not need to begin with a forward slash.

objectPath:"/Corporate
Employees/45_JaneDoe.xls"

Object Path

owner2

String

For objects in HCP namespaces, the user that owns the object. Valid values are:

For objects that have an owner:

USER,location,username

For objects with no owner:

GROUP,location,all_users

For objects that existed before the HCP system was upgraded from a pre-5.0 release and that have not subsequently had their owner changed:

nobody

In these values:

location is the location in which the user account for the object owner is defined. This can be:

oThe name of an HCP tenant

oThe internal ID of an HCP tenant

oAn Active Directory domain preceded by an at sign (@)

Internal IDs of HCP tenants are not returned in query results.

For objects with no owner, location is the name of the tenant that owns the namespace in which the object is stored.

owner:"USER,europe,pdgrey"

Owner

owner2
(continued)

String

username is the name of the user that owns the object. This can be:

oThe username of a user account that’s defined in HCP.

oThe username of an Active Directory user account. This can be either the user principal name or the Security Accounts Manager (SAM) account name for the user account.

This object property is not returned for objects in the default namespace.

If you are accessing the Search Console with a tenant-level user account that’s defined in HCP, you can specify this advanced query to find objects owned by that user account:

owner:USER

These considerations apply when you specify the owner property:

The entire value must be enclosed in double quotation marks (").

The asterisk (*) wildcard is not supported.

The location values you specify are not case sensitive.

The username values you specify, except for all_users, are not case sensitive.

USER, GROUP, and nobody are case sensitive.

 

Owner

replication
Collision

Boolean

An indication of whether the object is flagged as a replication collision. Valid values are:

true — The object is flagged as a replication collision.

false — The object is not flagged as a replication collision.

replicationCollision:true

Replication
  Collision

retention

Long

The end of the retention period for the object, in seconds since January 1, 1970, at 00:00:00 UTC. This value can also be:

0 Deletion Allowed

-1 Deletion Prohibited

-2 Initial Unspecified

retention:[1421107200 TO
1421193600]

Retention

retention
Class
3

String

The name of the retention class assigned to the object.

The values you specify for this property are case sensitive.

retentionClass:HlthReg-107

Retention
  Class

retention
String
1

String

The end of the retention period for this object in ISO 8601 format:

YYYY-MM-DDThh:mm:ssZ

For more information about this format, see the description of the accessTimeString property.

This value can also be one of these special values:

Deletion Allowed

Deletion Prohibited

Initial Unspecified

These special values are case sensitive.

retentionString:
“Initial Unspecified”

N/A

shred2

Boolean

An indication of whether the object will be shredded after it is deleted. Valid values are:

true — The object will be shredded.

false — The object will not be shredded.

shred:true

Shredding

size

Long

Object size, in bytes. This is the exact size of the object content. For example, to search for a two KB object, you need to specify 2048, not 2000.

size:[2000 TO 3000]

Size

updateTime

Long

The value of the POSIX mtime attribute for the object, in seconds since January 1, 1970, at 00:00:00: UTC.

updateTime:[1309478400
TO 1312156800]

N/A

updateTime
String
1

Datetime

The value of the POSIX mtime attribute for the object, in ISO 8601 format:

YYYY-MM-DDThh:mm:ssZ

For more information about this format, see the description of the accessTimeString property.

updateTimeString:
[2011-07-01T00:00:00-0400
TO
2011-08-01T00:00:00-0400]

N/A

utf8Name3

String

The UTF-8-encoded name of the object.

The values you specify for this property are case sensitive.

utf8Name:23_John_Doe.xls

Object
  Name

version

Unsigned long

The version ID of the object. All objects, including those in the default namespace, have version IDs.

When you specify the version ID of an old version, HCP returns information about the current version of the object.

version:83920048912257

N/A

Content property name4

The content property data type

A content property defined for the tenant.

+(sales:[3000000.00 TO *])

Content
  property
  name

1. HCP maintains the time for this property as a value that includes milliseconds, but the property format uses seconds. As a result, specifying a single datetime value for this property in a query does not return all expected results. Instead, take one of these actions:

 

Specify a range of values for the property.

Specify the corresponding property with the type long. For example, instead of specifying
ingestTimeString:2012-04-01T00:00:00, specify ingestTime:1333238400.

2. You cannot specify a range of values for this property.

3. You can use the asterisk (*) and question mark (?) wildcard characters when specifying values for this property.

4. For information about content properties see Content properties.

© 2015, 2020 Hitachi Vantara LLC. All rights reserved.