The document revision type represents a snapshot of a document at a defined point in time. It contains all document related data, including index data, document structure data and content.
name | data type | description |
---|---|---|
indexData | map of PropertyType | Returns the index data. |
documentElement | DocumentElementType | Returns the document element. |
documentId | DocumentReferenceType | Returns the document id. |
revisionTag | string | Returns the revision tag. |
revisionComment | string | Returns the revision comment. |
previousRevisionId | DocumentRevisionReferenceType | Returns the previous revision id. |
archiveReference | ArchiveReferenceType | Returns the archive reference. |
modificationMetaData | ModificationMetaDataType | |
contentMetaData | DocumentContentMetaDataType | |
retentionDescription | RetentionDescription | |
Properties inherited from ResourceType |
||
reference | ReferenceType | Returns the resource's object reference. |
Example
{ "indexData" : { "property1" : { "type" : "XML", "memberType" : "FLOAT", "propertyValue" : { } }, "property2" : { "type" : "LIST", "memberType" : "FLOAT", "propertyValue" : { } } }, "documentElement" : { "creationDate" : 12345, "variables" : { "property1" : "...", "property2" : "..." }, "nodeType" : "LINK", "children" : [ { }, { } ], "reference" : { } }, "documentId" : { "ddcName" : "...", "sysRowId" : "..." }, "revisionTag" : "...", "revisionComment" : "...", "previousRevisionId" : { "hdoc" : "..." }, "archiveReference" : { "name" : "...", "contentType" : "DOCUMENT" }, "modificationMetaData" : { "creationDate" : 12345, "creationUser" : { "type" : "GROUP", "name" : "...", "deleted" : true, "reference" : { } }, "lastModificationDate" : 12345, "lastModificationUser" : { "type" : "GROUP", "name" : "...", "deleted" : true, "reference" : { } } }, "contentMetaData" : { "hashes" : [ { "algorithmName" : "...", "hash" : "..." }, { "algorithmName" : "...", "hash" : "..." } ], "contentSize" : 12345, "compressedSize" : 12345, "storageSize" : 12345, "fileNames" : [ { "absolute" : true, "parentFile" : { }, "path" : "...", "absoluteFile" : { }, "parent" : "...", "file" : true, "canonicalFile" : { }, "name" : "...", "freeSpace" : 12345, "usableSpace" : 12345, "canonicalPath" : "...", "hidden" : true, "totalSpace" : 12345, "absolutePath" : "...", "directory" : true }, { "absolute" : true, "parentFile" : { }, "path" : "...", "absoluteFile" : { }, "parent" : "...", "file" : true, "canonicalFile" : { }, "name" : "...", "freeSpace" : 12345, "usableSpace" : 12345, "canonicalPath" : "...", "hidden" : true, "totalSpace" : 12345, "absolutePath" : "...", "directory" : true } ] }, "retentionDescription" : { "retentionTime" : 12345, "dispositionTime" : 12345, "litigationHold" : true, "contentType" : "...", "retentionClass" : "...", "lcmStage" : 12345 }, "reference" : { } }