Documents

GET 1.0/{InstanceId}/Documents?query.FolderId={query.FolderId}&query.IncludeSubFolders={query.IncludeSubFolders}&query.ContentSearchPhrase={query.ContentSearchPhrase}&pagingOptions.Skip={pagingOptions.Skip}&pagingOptions.Take={pagingOptions.Take}&SimpleSearch={SimpleSearch}

Retrieves a list of Document objects representing the search results.

Request Information

URI Parameters

API Parameter Details
Name	Description	Type	Additional information
InstanceId	The instance ID relating to a specific ADM database	string	Required
FolderId	The folder ID to search inside	integer	Required
IncludeSubFolders	Flagged to True when search should recurse through sub folders	boolean	None.
ContentSearchPhrase	Phrase to search for within the text of the actual files contained within the documents	string	None.
AttributeFilterTree	A tree structure of document attributes used to construct the DocumentFilterTreeQueryBase	AttributeFilterTree	None.
MetaDataFilterTree	A tree structure of Meta Data attributes used to construct the DocumentFilterTreeQueryBase	MetaDataFilterTree	None.
DocTypeId	The Document Type ID to filter the search resutls by	integer	Required
SortAttribute	Contains the information required to sort the document results of a query	SortAttribute	Required
Skip	The starting point from which to take the page	integer	None.
Take	The quantity of items to take (page size)	integer	None.
SimpleSearch	Set to True if only Simple search parameters are being utilised	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

A list of Document objects

Collection of Document

API Parameter Details
Name	Description	Type	Additional information
Id	The ID of the document	integer	None.
DocumentProperties	Contains a list of document attributes	DocumentProperties	None.
IndexingInfo	Contains Document Tag values, relating to a specific Document Type	IndexingInfo	None.
ContextPermissions	Contains a list of permissions that have been Allowed or Denied for this document	Collection of PermissionValuePair	None.
Versions	Contains a URL listing all versions of this document	string	None.
Notes	Contains a URL listing all Document Notes related to this document	string	None.
AuditEvents	Contains a list of Audit Events related to this document	string	None.
CurrentUserFollower	If this document is being followed by the current user, then this object is populated for the document / current user combination	Follower	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "DocumentProperties": {
      "FolderPath": "sample string 1",
      "ParentFolderId": 2,
      "Title": "sample string 3",
      "AddedByUserId": 4,
      "AddedByCloudGUID": "sample string 5",
      "AddedOn": "2025-11-13T01:17:19.4642558+00:00",
      "FileExt": "sample string 7",
      "CheckedOut": true,
      "Deleted": true
    },
    "IndexingInfo": {
      "DocTypeId": 1,
      "TagValues": [
        {
          "TagId": 1,
          "TagValue": {}
        },
        {
          "TagId": 1,
          "TagValue": {}
        }
      ]
    },
    "ContextPermissions": [
      {
        "Type": "Add",
        "Value": "Deny"
      },
      {
        "Type": "Add",
        "Value": "Deny"
      }
    ],
    "Versions": "sample string 2",
    "Notes": "sample string 3",
    "AuditEvents": "sample string 4",
    "CurrentUserFollower": {
      "Id": 1,
      "UserId": 2,
      "FollowerCloudGUID": "sample string 3"
    }
  },
  {
    "Id": 1,
    "DocumentProperties": {
      "FolderPath": "sample string 1",
      "ParentFolderId": 2,
      "Title": "sample string 3",
      "AddedByUserId": 4,
      "AddedByCloudGUID": "sample string 5",
      "AddedOn": "2025-11-13T01:17:19.4642558+00:00",
      "FileExt": "sample string 7",
      "CheckedOut": true,
      "Deleted": true
    },
    "IndexingInfo": {
      "DocTypeId": 1,
      "TagValues": [
        {
          "TagId": 1,
          "TagValue": {}
        },
        {
          "TagId": 1,
          "TagValue": {}
        }
      ]
    },
    "ContextPermissions": [
      {
        "Type": "Add",
        "Value": "Deny"
      },
      {
        "Type": "Add",
        "Value": "Deny"
      }
    ],
    "Versions": "sample string 2",
    "Notes": "sample string 3",
    "AuditEvents": "sample string 4",
    "CurrentUserFollower": {
      "Id": 1,
      "UserId": 2,
      "FollowerCloudGUID": "sample string 3"
    }
  }
]