netFolder Data Type

The metadata of a Net Folder

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs wrapped by description
allow_desktop_sync boolean element 0/1   Flag indicating whether the desktop application can sync files in the Net Folder.
assigned_right assignedRight element 0/unbounded assigned_rights List of users or groups that are allowed to access the Net Folder.

The only supported role in the AssignedRight Access object is ACCESS
home_dir boolean element 0/1   True if this is a user's home directory Net Folder.
id long element 0/1   The ID of the Net Folder
index_content boolean element 0/1   True if the file content in the net folder is indexed.

This attribute is ignored if inherit_index_content==true
inherit_index_content boolean element 0/1   Flag indicating whether the index_content setting should be inherited from the Net Folder Server.
inherit_jits_settings boolean element 0/1   Flag indicating whether the JITS settings should be inherited from the Net Folder Server.
inherit_sync_schedule boolean element 0/1   Flag indicating whether the synchronization schedule should be inherited from the Net Folder Server.
jits_enabled boolean element 0/1   Flag indicating whether JITS is enabled for this Net Folder

This attribute is ignored if inherit_jits_settings==true
jits_max_acl_age long element 0/1   Maximum age for ACL JITS results, in seconds.

This attribute is ignored if inherit_jits_settings==true
jits_max_age long element 0/1   Maximum age for JITS results, in seconds.

This attribute is ignored if inherit_jits_settings==true
name string element 0/1   The name of the Net Folder,

This must be unique.
relative_path string element 0/1   The path to this Net Folder.

This path is relative to the base path defined in the associated Net Folder Server.
server longIdLinkPair element 0/1   The ID and HRef of the Net Folder Server associated with this Net Folder.
sync_schedule schedule element 0/1   The synchronization schedule.

This attribute is ignored if inherit_sync_schedule==true
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

<net_folder>
  <id>...</id>
  <name>...</name>
  <server>
    <id>...</id>
    <href>...</href>
  </server>
  <relative_path>...</relative_path>
  <home_dir>...</home_dir>
  <index_content>...</index_content>
  <inherit_index_content>...</inherit_index_content>
  <inherit_jits_settings>...</inherit_jits_settings>
  <jits_enabled>...</jits_enabled>
  <jits_max_age>...</jits_max_age>
  <jits_max_acl_age>...</jits_max_acl_age>
  <only_sync_dirs>...</only_sync_dirs>
  <allow_desktop_sync>...</allow_desktop_sync>
  <inherit_client_sync_settings>...</inherit_client_sync_settings>
  <allow_client_initiated_sync>...</allow_client_initiated_sync>
  <inherit_sync_schedule>...</inherit_sync_schedule>
  <sync_schedule>
    <enabled>...</enabled>
    <when>...</when>
    <selected_days>
      <sun>...</sun>
      <mon>...</mon>
      <tue>...</tue>
      <wed>...</wed>
      <thu>...</thu>
      <fri>...</fri>
      <sat>...</sat>
    </selected_days>
    <at>
      <hour>...</hour>
      <minute>...</minute>
    </at>
    <every>
      <hour>...</hour>
      <minute>...</minute>
    </every>
  </sync_schedule>
  <assigned_rights>
    <assigned_right>
      <principal>
        <type>...</type>
      </principal>
      <access>
        <role>...</role>
        <sharing/>
      </access>
    </assigned_right>
  </assigned_rights>
  <href>...</href>
  <links>
    <link>
      <href>...</href>
      <rel>...</rel>
    </link>
  </links>
</net_folder>