Comments

Get Comments For a Root Annotation in a Layer

Use this endpoint to list all the comments attached to the given annotation in the document's layer with the specified name.

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

Request

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

Path parameters

documentIdstring required

The document ID

layerNamestring required

The layer name

annotationIdstring required

The ID of the annotation

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 responded with comments

Example response

{
  "data": {
    "comments": [
      {
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
        "content": {
          "rootId": "01HBDGR9D5JTFERPSCEMNH5GPG",
          "text": {
            "value": "Annotation with <b>xhtml</b> contents."
          },
          "createdAt": "2019-09-16T15:05:03.712909Z",
          "creatorName": "John Doe",
          "updatedAt": "2019-09-16T15:05:03.712909Z"
        }
      }
    ]
  }
}

Changes

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