Object properties

Content Platform Tenant Management Help

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

The table below describes the object properties that you can specify in these contexts:

  • objectProperties entry
  • sort entry
  • Query entry

In the sort and objectProperties entries, you specify only the object property name. In query expressions, you specify both the property name and one or more values for the property.

The properties listed below are also returned in response bodies. The verbose and objectProperties request entries determine which properties are returned.

Object property Data type Description Query expression example
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]
accessTime String1 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

The UTC offset is optional. If you omit it, the time is in the zone of the HCP system.

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

accessTimeString:
[2012-03-01
T00:00:00 TO
2012-03-01
T23:59:59]
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
aclGrant String

ACL content.

This property can be used only in queries. It cannot be used in sort or objectProperties properties.

aclGrant:"Ww,USER,
europe,rsilver"
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 time values for versions of an object are unique.

This property is not returned for objects with the

NOT_FOUND operation type. For more information about this operation type, see the description of the operation entry.

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

changeTimeMilliseconds:
 [1311206400000.00 TO
1311292800000.00]
changeTime String1 Datetime

The object change time 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:
[2012-03-21
T00:00:00 TO
2012-03-21
T23:59:59]
custom Metadata2 Boolean

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

true
The object has custom
false
The object does not have custom metadata.
customMetadata:true
custom Metadata Annotation String One or more comma-delimited annotation names. Annotation names are case-sensitive.
customMetadata
Annotation:inventory
custom Metadata Content String

Custom metadata content.

This property can be used only in queries. It cannot be used in sort or objectProperties properties.

customMetadata
Content:city.Bath.
city
dpl Integer The DPL for the namespace that contains the object.
dpl:2
gid3 Integer The POSIX group ID. N/A
hash4 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.

In query expressions, the values you specify for both the hash algorithm and the hash value are case sensitive. You need to use uppercase letters when specifying these values.

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 quotation marks.

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.

hash:"SHA-256 9B6D4..."
hashScheme4 String

The cryptographic hash algorithm the namespace uses.

In query expressions, the values you specify for this property are case sensitive. Do not enclose these values in quotation marks.

hashScheme:SHA-256
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
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
ingestTime Long The time at which HCP stored the object, in seconds since January 1, 1970, at 00:00:00 UTC.
ingestTime:[130947840
TO 1312156800]
ingestTime String1 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:
[2012-03-01
T00:00:00
TO 2012-03-01
T23:59:59]
namespace2 String

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

namespace-name.tenant-name

In query expressions, the values you specify for this property are not case sensitive.

namespace:
finance.europe
objectPath4 String

The path to the object following rest, data, or fcfs_data, beginning with a forward slash (/).

In query expressions, 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_Jane_Doe.xls"
operation3 String

The type of operation the result represents.

Possible values in a response body are:

  • CREATED
  • DELETED
  • DISPOSED
  • PRUNED
  • PURGED
  • NOT_FOUND

PRUNED and PURGED do not apply to objects in the default namespace.

Results for object-based queries have either the CREATED or NOT_FOUND operation type. NOT_FOUND means that the object has been deleted from the repository but has not yet been removed from the index. The NOT_FOUND operation type is returned only for queries that specify true in the verbose entry.

N/A
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 been assigned an owner:
    nobody

In these values:

  • location is the location in which the user account for the object owner is defined. This can be:
    • The name of an HCP tenant
    • The internal ID of an HCP tenant
    • An 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.

  • username is the name of the user that owns the object. This can be:
    • The username of a user account that’s defined in HCP.
    • The 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 property is not returned for objects in the default namespace.

    If the Authorization header or hcp-ns-auth cookie identifies a tenant-level user, you can specify this criterion in a query expression to find all objects owned by that user:

    owner:USER
owner:"USER,europe,pdgrey"
owner2 (continued) String

These considerations apply when you specify the owner property in a query expression:

  • The entire value must be enclosed in double quotation marks.
  • USER, GROUP, and nobody are case sensitive.
  • The location values you specify are not case sensitive.
  • The username values you specify, except for all_users, are not case sensitive.
permissions3 Integer The octal value of the POSIX permissions for the object. N/A
replicated3 Boolean

An indication of whether the object has been replicated. Possible values in a response body are:

true
The object, including the current version and all metadata, has been replicated.
false
The object has not been replicated.
N/A
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
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:"-1"
retentionClass4 String

The name of the retention class assigned to the object.

If the object is not assigned to a retention class, this value is an empty string in the query results.

In query expressions, the values you specify for this property are case sensitive.

retentionClass:Reg-107
retention String1 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

In query expressions, these special values are case sensitive.

In query results, this property also displays the retention class and retention offset, if applicable.

retentionString:
“2015-03-02T
12:00:00-0500”
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
size Long The size of the object content, in bytes.
size:[2000 TO 3000]
type3 String The object type. In a response body, this value is always object. N/A
uid3 Integer The POSIX user ID. N/A
urlName3 String

The fully qualified object URL. For example:

https://finance.europe.hcp.example.com/rest/Presentations/

Q1_2012.ppt

N/A
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]
updateTime String1 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:
[2012-04-01
T00:00:00
TO 2012-04-30
T23:59:59]
utf8Name4 String

The UTF-8-encoded name of the object.

In query expressions, the values you specify for this property are case sensitive.

utf8Name:23_John_Doe.xls
version

Unsigned

long

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

This property is not returned for objects with the

NOT_FOUND operation type. For more information about this operation type, see the operation entry, above.

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

version:83920048912257
content-property-name4 Depends on property type The value of a content property.
doctor_name: "John Smith"
Notes:
  1. HCP maintains the time for this property as a value that includes millisecond, 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. To retrieve all expected results, take one of these actions:
    • Specify a range of values for this property.
    • Specify a value for the corresponding long-type object property. 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. For object-based queries, you can specify this property only in the objectProperties entry. If you specify this property in either the sort or query entry, HCP returns a 400 (Bad Request) error.
  4. You can use the asterisk (*) and question mark (?) wildcard characters when specifying values for this property.