Documents

GET 1.0/{InstanceId}/Documents/{DocumentId}

Returns a single document

Request Information

URI Parameters

API Parameter Details
Name	Description	Type	Additional information
InstanceId	The instance ID relating to a specific ADM database	string	Required
DocumentId	The ID of the document to be retrieved	integer	Required

Body Parameters

None.

Response Information

Resource Description

A single document with all corresponding attributes and meta data

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-05-19T14:18:11.67116+01: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"
  }
}