FileDocumentElementType Data Type

This document element type indicates that the current element represents a given file.

Properties
name data type constraints description
pageNumber number required int Returns the page Number of document.
originalFormat boolean required boolean Returns the original format flag.
fileName File   Returns the file name.
picture boolean required boolean Returns the isPicture flag.
chunkedOnMedium boolean required boolean Returns the cunkedOnMedium flag.
Properties inherited from ContentDocumentElementType
annotations array of AnnotationType   Returns the annotations.
nodeType DocumentNodeType   Returns the document node type.
children array of DocumentElementType   Returns the document element children.
content InputStream   Returns the content.
contentMetaData ContentMetaDataType  
Properties inherited from DocumentElementType
creationDate number   Returns the creation date.
variables map of string   Returns the element variables.
nodeType DocumentNodeType   Returns the document node type.
children array of DocumentElementType   Returns the document element children.
Properties inherited from ResourceType
reference ReferenceType   Returns the resource's object reference.

Example

{
  "pageNumber" : 12345,
  "originalFormat" : true,
  "fileName" : {
    "canonicalPath" : "...",
    "canonicalFile" : { },
    "absolutePath" : "...",
    "name" : "...",
    "absolute" : true,
    "freeSpace" : 12345,
    "usableSpace" : 12345,
    "path" : "...",
    "totalSpace" : 12345,
    "absoluteFile" : { },
    "directory" : true,
    "parentFile" : { },
    "parent" : "...",
    "hidden" : true,
    "file" : true
  },
  "picture" : true,
  "chunkedOnMedium" : true,
  "annotations" : [ {
    "accessData" : {
      "aclName" : "...",
      "creationDate" : 12345,
      "creationUser" : 12345,
      "lastModificationDate" : 12345,
      "lastModificationUser" : 12345
    },
    "height" : 12345,
    "page" : 12345,
    "width" : 12345,
    "x" : 12345,
    "y" : 12345
  }, {
    "accessData" : {
      "aclName" : "...",
      "creationDate" : 12345,
      "creationUser" : 12345,
      "lastModificationDate" : 12345,
      "lastModificationUser" : 12345
    },
    "height" : 12345,
    "page" : 12345,
    "width" : 12345,
    "x" : 12345,
    "y" : 12345
  } ],
  "nodeType" : "CONTENT",
  "children" : [ {
    "creationDate" : 12345,
    "variables" : {
      "property1" : "...",
      "property2" : "..."
    },
    "nodeType" : "CONTENT",
    "children" : [ { }, { } ],
    "reference" : { }
  }, {
    "creationDate" : 12345,
    "variables" : {
      "property1" : "...",
      "property2" : "..."
    },
    "nodeType" : "LINK",
    "children" : [ { }, { } ],
    "reference" : { }
  } ],
  "content" : { },
  "contentMetaData" : {
    "hash" : "...",
    "uncompressedSize" : 12345,
    "compressedSize" : 12345,
    "hashAlgorithm" : "..."
  },
  "creationDate" : 12345,
  "variables" : {
    "property1" : "...",
    "property2" : "..."
  },
  "reference" : { }
}