Bookmarks

Create a Bookmark in a Layer

Bookmarks can be created with and without specifying the ID for the bookmark. When no ID is specified, Document Engine will assign a random ID to the bookmark. If you want to rely on a specific ID being the ID of the created bookmark, the ID can be set with the id property in the JSON payload. This is useful if you, for example, want a bookmark with the same ID in multiple documents.

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

Request

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

createdBystring nullable

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

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.

idstring required

An unique Instant JSON identifier of the record. Must be unique in a layer.

Example request

{
  "content": {
    "action": {
      "relativePath": "/other_document.pdf"
    }
  },
  "id": "01DNEDPQQ22W49KDXRFPG4EPEQ"
}

Response

The newly created bookmark

Changes

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