Layers

Copy the Layer Into a New Document, Applying the Instant JSON

If the content type of the request is multipart/form-data, the document with the chosen layer will be copied, and the uploaded instant.json file will be imported into the default layer.

If the content type is application/json, the request body is ignored and the layer is copied as-is, without any modifications to the default layer.

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

Request

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

object nullable required

Response

The layer has been copied successfully.

createdAtstring required

Date and time in ISO8601 format with timezone.

documentIdstring required

The ID of the document.

password_protectedboolean required

Indicates whether the document is password protected.

sourcePdfSha256string required

SHA256 hash of the PDF file underlying the document.

titlestring nullable required

The document title.

Example response

{
  "createdAt": "2019-09-16T15:05:03.712909Z",
  "documentId": "7KPZW8XFGM4F1C92KWBK1B748M",
  "password_protected": true,
  "sourcePdfSha256": "1defd934dbbf77587eb9b7f45d162d2a3aea16c840a9e7cfa190fb2ea1f40a76",
  "title": "Nutrient Document Engine API Specification"
}

Changes

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