DocumentModel Data Type

A PDF document.

Properties
name data type description
author string The document's author.
creationDate string The date the document was created. (ISO-8601 format)
creator string The document's creator.
keywords string The document's keywords.
modDate string The date the document was last modified. (ISO-8601 format)
pageCount number The number of pages in the document.
producer string The document's producer.
subject string The document's subject.
title string The title of the document.
linearized boolean True if the document is linearized.
encrypted boolean True if the document is encrypted.
encryption string The encryption algorithm and length.
content LinkModel Link to the document's content.
pages LinkModel Link to the document's pages.
annotations LinkModel Link to the document's annotations.
bookmarks LinkModel Link to the document's bookmarks.
attachments LinkModel Link to the document's attachments.
fields LinkModel Link to the document's fields.
signatureFields LinkModel Link to the document's signature fields.
allPermissions LinkModel Link to the document's pdf permissions.
passwordPermissions LinkModel Link to the document's password permissions.
pageMode string The value of the page mode viewer preference in the document. The page mode is used when the document is opened in a PDF viewer. This value can either be null or one of:
PAGEMODE_USENONE: Neither document outline nor thumbnail images are visible.
PAGEMODE_USEOUTLINES: Document outline visible.
PAGEMODE_USETHUMBS: Thumbnail images visible.
PAGEMODE_FULLSCREEN: Full screen mode, with no menu bar, window controls, or any other window visible.
PAGEMODE_USEOC: Optional content group panel visible (PDF 1.5 and up).
PAGEMODE_USEATTACHMENTS: Attachments panel visible (PDF 1.6 and up).
Properties inherited from FileModel
path string The path to this file.
link LinkModel The link to this file.
bytes number The size of the file in bytes.

Example

{
  "author" : "...",
  "creationDate" : "...",
  "creator" : "...",
  "keywords" : "...",
  "modDate" : "...",
  "pageCount" : 12345,
  "producer" : "...",
  "subject" : "...",
  "title" : "...",
  "linearized" : true,
  "encrypted" : true,
  "encryption" : "...",
  "content" : {
    "rel" : "...",
    "href" : "..."
  },
  "pages" : {
    "rel" : "...",
    "href" : "..."
  },
  "annotations" : {
    "rel" : "...",
    "href" : "..."
  },
  "bookmarks" : {
    "rel" : "...",
    "href" : "..."
  },
  "attachments" : {
    "rel" : "...",
    "href" : "..."
  },
  "fields" : {
    "rel" : "...",
    "href" : "..."
  },
  "signatureFields" : {
    "rel" : "...",
    "href" : "..."
  },
  "allPermissions" : {
    "rel" : "...",
    "href" : "..."
  },
  "passwordPermissions" : {
    "rel" : "...",
    "href" : "..."
  },
  "pageMode" : "...",
  "path" : "...",
  "link" : {
    "rel" : "...",
    "href" : "..."
  },
  "bytes" : 12345
}