PHphilterd
Legal Holds

Set a legal hold.

Changed on

Creates a named hold that blocks deletion and purge of the specified evidence until the hold is released. The reference must be unique for the calling user. Two scope types are supported: 'document_chain' protects a specific document's ledger chain; 'user' protects all governance evidence owned by the hold's owner, which is the caller or the user named by owner. For a user hold, scopeValue is optional; if given it must be the owner's username, and the owner's username is stored either way. Admins may place a hold on another user's evidence via the owner parameter. Requires the holds:write scope.

post/api/holds

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/holds
  • Auth
    HTTP bearer

Query parameters

ownerstring

Headers

Authorizationstring required

Request body

reasonstring
referencestring
scopeTypestring
scopeValuestring

For document_chain, the document id (required). For user, optional: the hold covers all of its owner's evidence, and if given this must be the owner's username, which is stored either way.

Response

The hold was set and is now active.

reasonstring
referencestring
scopeTypestring
scopeValuestring
setAtstring date-time

Changes

  • c4f85daa9208Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 64dc022f562eRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new hold_exists enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status

    • info

      added the optional property to the response with the status