Comments

Add Comments in a Layer

Use this endpoint to add comments and their root annotation at the same time.

Note that the annotation needs to be either a markup annotation or a comment marker.

The id and createdAt properties of the comment are autogenerated by Document Engine if they are not provided.

post/api/documents/{documentId}/layers/{layerName}/comments

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/layers/{layerName}/comments
  • 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.

Request body

Example request

{
  "annotation": {
    "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"
  },
  "comments": [
    {
      "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
      "content": {
        "text": "What a wonderful idea!",
        "createdAt": "2019-11-14T15:05:03.089Z",
        "updatedAt": "2019-11-22T18:05:03.712Z",
        "creatorName": "John Doe"
      }
    }
  ]
}

Response

The comments have been added to the annotation

Example response

{
  "data": {
    "annotation": {
      "id": "01DNEDPQQ22W49KDXRFPG4EPEQ"
    },
    "comments": [
      {
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ"
      }
    ]
  }
}

Changes

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