POST

Content Platform Tenant Management Help

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

Changes one or more of these metadata values:

  • Hold status
  • Index setting
  • Retention setting
  • Shred setting
  • Object owner

Permissions

For all operations: write

For hold: privileged

For owner: change owner

Elements

  • Authorization header
  • Object URL
  • A body containing these form-encoded values:
    • To hold or release, this URL query parameter:
      hold=true|false
    • To change the index setting, this URL query parameter:
      index=true|false
    • To change the retention setting, this URL query parameter:
      retention=retention-expression
    • To add or change a labeled retention hold, this query parameter:
      label_hold = 
        [{"id":"UniqueLabelHold-1","hold":true|false}, 
        {"id":"UniqueLabelHold-2","hold":true|false}]
    • To specify that the object will be shredded, this URL query parameter:
      shred=true
    • To change the owner of the object, this URL query parameter:
      owner=user-name
    • If the owner query parameter specifies an Active Directory user, this URL query parameter:
      domain=ad-domain

Response headers

  • X-HCP-ServicedBySystem
  • X-HCP-ErrorMessage

    (if an error occurred and more information is available)

Status codes

Success: 200

Error: 400, 403, 404, 414, 500, 503