fileProperties Data Type

File metadata.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs wrapped by description
name string element 0/1   The file name.
owning_entity entityId element 0/1   Entity to which the file belongs.
parent_binder parentBinder element 0/1   The parent folder where the file resides.
permalink link element 0/unbounded permalinks  
permalink string element 0/1   The web application URL of the file.
Properties inherited from baseFileProperties
creation historyStamp element 0/1   The date and time when the file was created.
id string element 0/1   The ID of the file.
length long element 0/1   The file size in bytes.
md5 string element 0/1   MD5 checksum.
modification historyStamp element 0/1   The datae and time when the file was last modified.
version_number int element 0/1   File version number. This is incremented each time the file is modified.
Properties inherited from searchableObject
doc_type string element 0/1   The indexed document type. Possible values are:
  • entry (folder entries, replies, users and groups)
  • binder (workspaces and folders)
  • file
Properties inherited from baseRestObject
href string element 0/1   The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
link link element 0/unbounded links Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

<file>
  <permalinks>
    <permalink>
      <href>...</href>
      <rel>...</rel>
    </permalink>
  </permalinks>
  <owning_entity>
    <type>...</type>
    <id>...</id>
    <href>...</href>
  </owning_entity>
  <parent_binder>
    <path>...</path>
    <id>...</id>
    <href>...</href>
  </parent_binder>
  <name>...</name>
  <permalink>...</permalink>
  <id>...</id>
  <creation>
    <principal/>
    <date>...</date>
  </creation>
  <modification>
    <principal/>
    <date>...</date>
  </modification>
  <length>...</length>
  <md5>...</md5>
  <version_number>...</version_number>
  <doc_type>...</doc_type>
</file>