Annotations

Get an Annotation From a Layer

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

Request

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

idstring

Annotation ID, unique in scope of a single Instant Layer.

createdBystring nullable required

The user identifier.

Note that Nutrient Document Engine does not provide any kind of user management and accepts any string (or null) as a valid user ID.

For records created or updated in the browser, the user_id is extracted from the JSON Web Token (JWT) used for authentication.

updatedBystring nullable required

The user identifier.

Note that Nutrient Document Engine does not provide any kind of user management and accepts any string (or null) as a valid user ID.

For records created or updated in the browser, the user_id is extracted from the JSON Web Token (JWT) used for authentication.

groupstring nullable

The resource group.

Group allows to grant access to resources via Collaboration Permissions.

Example response

{
  "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.