PHphilterd
Documents

Get the status of an async redaction.

Changed on

Returns the status, any error, the effective configuration hash, and the policy the document was submitted with: policyName, policyVersion, and policyContentHash. Read that revision with GET /api/policies/{policyName}/versions/{revision}. Requires the documents:read scope.

get/api/documents/{documentId}/status

Request

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

Path parameters

documentIdstring required

Query parameters

ownerstring

Headers

Authorizationstring required

Response

OK

typestring
documentIdstring
effectiveConfigurationHashstring
errorstring
policyContentHashstring
policyNamestring
policyVersioninteger
statusstring

Changes

  • c715ad02bcdbRevision changes
    • info

      added the optional property to the response with the status

  • f91f9e9c929cRevision 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