NetFolder Data Type

The metadata of a Net Folder

Properties
name data type description
allow_desktop_sync boolean Flag indicating whether the desktop application can sync files in the Net Folder.
assigned_rights array of AssignedRight 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 True if this is a user's home directory Net Folder.
id number The ID of the Net Folder
index_content boolean True if the file content in the net folder is indexed.

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

This attribute is ignored if inherit_jits_settings==true
jits_max_acl_age number Maximum age for ACL JITS results, in seconds.

This attribute is ignored if inherit_jits_settings==true
jits_max_age number Maximum age for JITS results, in seconds.

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

This must be unique.
relative_path string The path to this Net Folder.

This path is relative to the base path defined in the associated Net Folder Server.
server LongIdLinkPair The ID and HRef of the Net Folder Server associated with this Net Folder.
sync_schedule Schedule The synchronization schedule.

This attribute is ignored if inherit_sync_schedule==true
Properties inherited from BaseRestObject
href string The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
links array of Link Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

{
  "id" : 12345,
  "name" : "...",
  "server" : {
    "id" : 12345,
    "href" : "..."
  },
  "relative_path" : "...",
  "home_dir" : true,
  "index_content" : true,
  "inherit_index_content" : true,
  "inherit_jits_settings" : true,
  "jits_enabled" : true,
  "jits_max_age" : 12345,
  "jits_max_acl_age" : 12345,
  "only_sync_dirs" : true,
  "allow_desktop_sync" : true,
  "inherit_client_sync_settings" : true,
  "allow_client_initiated_sync" : true,
  "inherit_sync_schedule" : true,
  "sync_schedule" : {
    "enabled" : true,
    "when" : "...",
    "selected_days" : {
      "sun" : true,
      "mon" : true,
      "tue" : true,
      "wed" : true,
      "thu" : true,
      "fri" : true,
      "sat" : true
    },
    "at" : {
      "hour" : 12345,
      "minute" : 12345
    },
    "every" : {
      "hour" : 12345,
      "minute" : 12345
    }
  },
  "assigned_rights" : [ {
    "principal" : {
      "type" : "...",
      "id" : 12345,
      "href" : "..."
    },
    "access" : {
      "role" : "...",
      "sharing" : { },
      "href" : "...",
      "links" : [ { }, { } ]
    }
  }, {
    "principal" : {
      "type" : "...",
      "id" : 12345,
      "href" : "..."
    },
    "access" : {
      "role" : "...",
      "sharing" : { },
      "href" : "...",
      "links" : [ { }, { } ]
    }
  } ],
  "href" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ]
}