GET, except for namespace information requests

Content Platform Tenant Management Help

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

Retrieves:

  • Objects
  • Versions
  • Annotations
  • ACLs

Lists:

  • Versions
  • Directories
  • Annotations

Permissions

For object, version, and annotation operations: read

To retrieve directory listings: browse

To retrieve ACLs: read ACL

Elements

For all operations:

  • Authorization header
  • Object, directory, or symbolic link URL

To retrieve data in Gzip format, an Accept-Encoding header that contains gzip or *.

To retrieve a specific version, an annotation or ACL for a specific version, or list annotations for a specific version, this URL query parameter:

version=version-id

To retrieve a version list, this URL query parameter:

version=list

To list deleted objects or versions, this URL query parameter:

deleted=true

To choose not to wait for delayed retrievals, this URL query parameter:

nowait

To retrieve object or version data and an annotation together:

  • This URL query parameter:
    type=whole-object
  • To control the order of the returned information, an X-HCP-CustomMetadataFirst request header with a value of true or false (the default)

To retrieve part of an object or version, an HTTP Range header specifying any of these zero-indexed byte ranges:

  • start-position-end-position
  • start-position-
  • -offset-from-end

To conditionally retrieve an object or version, these headers:

  • If-Match: etag-list
  • If-None-Match: etag-list
  • If-Modified-Since: datetime
  • If-None-Modified-Since: datetime

To force HCP to generate an ETag if the object does not yet have one:

forceEtag=true

To include or exclude the X-HCP-Replicated header in the response, this header:

X-HCP-Get-Replicated: true|false

To have change times for subdirectories in a directory listing reflect object additions and deletions, this URL query parameter:

mostRecentDirTimes=true

To retrieve an annotation, these as URL query parameters:

type=custom-metadata

annotation=annotation-name

The annotation name is optional for the default annotation.

To list annotations, this URL query parameter:

type=custom-metadata-info

To retrieve only an ACL, this URL query parameter:

type=acl

Optionally, to specify the format for the returned ACL, a Content-Type header with one of:

application/json

application/xml (the default)

Response headers

Standard

  • X-HCP-Time
  • X-HCP-SoftwareVersion
  • X-HCP-ServicedBySystem
  • X-HCP-SymlinkTarget

    (if URL is a symbolic link)

  • X-HCP-ErrorMessage

    (if an error occurred and more information is available)

Objects, versions, directory listings, and annotations:

  • X-HCP-ChangeTime Milliseconds
  • X-HCP-ChangeTime String

Objects, versions, and annotations:

  • ETag

Objects and versions:

  • Last-Modified
  • X-HCP-ACL
  • X-HCP-Custom-Metadata
  • X-HCP-Domain
  • X-HCP-DPL
  • X-HCP-GID
  • X-HCP-Hash

    (not returned for multipart objects)

  • X-HCP-Index
  • X-HCP-IngestProtocol
  • X-HCP-IngestTime
  • X-HCP-LabelRetentionHold
  • X-HCP-LabelRetentionHold-Labels
  • X-HCP-Owner
  • X-HCP-Replicated
  • X-HCP-Retention
  • X-HCP-RetentionClass
  • X-HCP-RetentionHold
  • X-HCP-RetentionString
  • X-HCP-Shred
  • X-HCP-Size
  • X-HCP-Type
  • X-HCP-UID
  • X-HCP-VersionID

Partial objects and versions:

  • Content-Range

Objects and versions with annotations:

  • X-HCP-CustomMetadata Annotations
  • X-HCP-CustomMetadata ContentType
  • X-HCP-CustomMetadata First
  • X-HCP-DataContentType

Annotations:

  • X-HCP-ContentLength
  • X-HCP-Hash
  • X-HCP-Size

If response is in Gzip compressed format:

  • Content-Encoding
  • X-HCP-ContentLength

Directory listings:

X-HCP-Type

Status codes

Success: 200, 206

Error: 314, 400, 403, 404, 406, 412, 414, 416, 500, 503