GET 1.0/{InstanceId}/Documents/{DocumentId}/Notes
Retrieves all notes for a specific Document
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| InstanceId |
The instance ID relating to a specific ADM database |
string |
Required |
| DocumentId |
The ID of the document whose notes are to be retrieved |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of Note objects
Collection of Note| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The ID of the note |
integer |
None. |
| NoteType |
The type of the note |
NoteType |
None. |
| OwnerUserId |
The user who created and owns the note |
integer |
None. |
| OwnerCloudGUID |
The GUID of the user who created and owns the note |
string |
None. |
| DateEntered |
The date when the note was created |
date |
None. |
| LastEditUserId |
The ID of the user who last edited the note |
integer |
None. |
| LastEditUserCloudGUID |
The GUID of the user who last edited the note |
string |
None. |
| DateEdited |
The date that the note was last edited |
date |
None. |
| Content |
The text of the note |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": 1,
"NoteType": "Public",
"OwnerUserId": 2,
"OwnerCloudGUID": "sample string 3",
"DateEntered": "2025-05-19T14:41:19.9688923+01:00",
"LastEditUserId": 5,
"LastEditUserCloudGUID": "sample string 6",
"DateEdited": "2025-05-19T14:41:19.9688923+01:00",
"Content": "sample string 8"
},
{
"Id": 1,
"NoteType": "Public",
"OwnerUserId": 2,
"OwnerCloudGUID": "sample string 3",
"DateEntered": "2025-05-19T14:41:19.9688923+01:00",
"LastEditUserId": 5,
"LastEditUserCloudGUID": "sample string 6",
"DateEdited": "2025-05-19T14:41:19.9688923+01:00",
"Content": "sample string 8"
}
]