Folders

GET 1.0/{InstanceId}/Folders?IncludeDocumentCounts={IncludeDocumentCounts}

Gets a list of folders within the Filing Structure, starting at the Filing Root

Request Information

URI Parameters

API Parameter Details
Name	Description	Type	Additional information
InstanceId	The instance ID relating to a specific ADM database	string	Required
IncludeDocumentCounts	When True, returns the count of documents for each folder (non-recursive)	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

A list of Folders and sub folders (recursive)

Collection of Folder

API Parameter Details
Name	Description	Type	Additional information
Id	The ID of the folder	integer	None.
Url	A URL referencing this folder object	string	None.
Name	Name of the folder	string	None.
Level	The hirearchical level of this folder, starting at 0 for roots (such as FilingRoot and UserInbox)	integer	None.
ParentId	The ID of the parent folder	integer	None.
NodeType	Describes the node type (type of folder)	string	None.
ContextPermissions	Contains the permissions relevant to this folder (for example ChangePermissions, Delete, Email, VersionControl, View)	Collection of PermissionValuePair	None.
PermissionEntries	A URL which can be used to retrieve the permission entries for this folder	string	None.
DocumentCount	The number of documents contained in this folder (not recursive)	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Url": "sample string 2",
    "Name": "sample string 3",
    "Level": 4,
    "ParentId": 5,
    "NodeType": "sample string 6",
    "ContextPermissions": [
      {
        "Type": "Add",
        "Value": "Deny"
      },
      {
        "Type": "Add",
        "Value": "Deny"
      }
    ],
    "PermissionEntries": "sample string 7",
    "DocumentCount": 1
  },
  {
    "Id": 1,
    "Url": "sample string 2",
    "Name": "sample string 3",
    "Level": 4,
    "ParentId": 5,
    "NodeType": "sample string 6",
    "ContextPermissions": [
      {
        "Type": "Add",
        "Value": "Deny"
      },
      {
        "Type": "Add",
        "Value": "Deny"
      }
    ],
    "PermissionEntries": "sample string 7",
    "DocumentCount": 1
  }
]