PHphilterd
Redaction Ledger

Get a document's ledger chain.

Changed on

Returns a page of a document's ledger entries, in chain order, with how many the chain has and whether the whole chain currently verifies. Page with offset and limit; read every entry at once with the export. A chain that cannot be validated, such as one with an entry that can no longer be read, returns valid false with a validationError and no entries. Requires the ledger:read scope.

get/api/ledger/{documentId}

Request

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

Path parameters

documentIdstring required

Query parameters

ownerstring
offsetinteger
limitinteger

Headers

Authorizationstring required

Response

OK

documentIdstring
hashChainValidboolean
signaturesValidboolean
signedEntriesinteger
totalinteger

How many entries the whole chain has, across every page. Left out with entries.

unsignedEntriesinteger
validboolean
validationErrorstring

Why the chain could not be validated. Present only then, with valid false and the hash, signature, and entry-count fields left out.

Changes

  • a80ec02d6633Revision changes
    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the optional property to the response with the status

  • 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

    • 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