Annotations

Get Annotations in a Layer

You can use this endpoint to fetch all annotations from the given layer.

If Accept: application/json header is used, only the first 1000 annotations from the page will be returned. If the page has more than 1000 annotations, the truncated property in the response is set to true.

In order to consume greater number of annotations in a controlled manner, use application/x-ndjson as accepted content type. When Accept: application/x-ndjson header is used, the response will be returned as Newline delimited JSON, allowing the client to process annotations individually or in batches before the complete response body has been received.

get/api/documents/{documentId}/layers/{layerName}/annotations

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/layers/{layerName}/annotations
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

layerNamestring required

The layer name

Headers

pspdfkit-pdf-passwordstring

The PDF document password.

The value can be either a plain-text password or a base64 encoded password in a form base64:<encoded-password>. Use the Base64 encoding if your password contains characters that are not allowed in HTTP header or would be otherwise mangled (e.g. trailing or leading spaces)

If the document is password protected, any operations performed on it require supplying a password.

Response

Document Engine returned layers's first 1000 annotations or a stream of all the document's annotations.

Example response

{
  "data": {
    "annotations": [
      {
        "content": {
          "bbox": [
            255.10077620466092,
            656.7566095695641,
            145.91672653256705,
            18.390804597701162
          ],
          "action": {
            "relativePath": "/other_document.pdf"
          },
          "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
          "createdAt": "2019-09-16T15:05:03.712909Z",
          "updatedAt": "2019-09-16T15:05:03.712909Z",
          "customData": {
            "foo": "bar"
          },
          "rects": [
            [
              100,
              200,
              300,
              400
            ]
          ],
          "color": "#fcee7c",
          "note": "This is a note."
        },
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.