GET api/Notes/{id}?mainEntityType={mainEntityType}
Get all Histories linked to a main entity record. Supported Headers: Filter, Take, Skip, Sort, SortDesc, SelectField, IncludeLink, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Id of the main entity record |
globally unique identifier |
Required |
mainEntityType | MainEntityType |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of NoteName | Description | Type | Additional information |
---|---|---|---|
HasAttachment | boolean |
None. |
|
Attachment | Attachment |
None. |
|
EditDate |
SQL Column Name: [EDIT_DATE] |
date |
None. |
CreateDate |
SQL Column Name: [CREATE_DATE] |
date |
None. |
DisplayDate |
SQL Column Name: [NOTE_DATE] |
date |
None. |
NoteText |
SQL Column Name: [NOTE] |
string |
None. |
NoteTypeID |
SQL Column Name: [NOTETYPEID] |
integer |
None. |
ID |
SQL Column Name: [NOTEID] |
globally unique identifier |
None. |
ManageUserID | globally unique identifier |
None. |
|
ManageUserName |
SQL Column Name: [RECORD_MANAGER] |
string |
None. |
CreateUserID | globally unique identifier |
None. |
|
CreateUserName |
SQL Column Name: [RECORD_CREATOR] |
string |
None. |
EditUserID | globally unique identifier |
None. |
|
EditUserName |
SQL Column Name: [LAST_EDITED_BY] |
string |
None. |
IsPrivate |
SQL Column Name: [PRIVATE] |
boolean |
None. |
LinkedEntities | LinkedEntities |
None. |
Response Formats
application/json, text/json
Sample:
[ { "HasAttachment": true, "Attachment": { "DisplayName": "sample string 1", "FileSize": 2.1, "LastModified": "2024-05-04T07:19:23Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-04T07:19:23Z", "CreateDate": "2024-05-04T07:19:23Z", "DisplayDate": "2024-05-04T07:19:23Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "6681575b-e26a-449e-b232-ef2c6936c210", "ManageUserID": "a3052784-4974-44bc-93de-c38f599ec2b5", "ManageUserName": "sample string 9", "CreateUserID": "8db9bf8b-1e36-4662-80e1-da444e9fa3d3", "CreateUserName": "sample string 11", "EditUserID": "4f50ffb7-41fb-453f-a89d-eda0aabed60f", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "92dafec0-2b8a-4016-a2c2-ec811e08778d", "f8ec787f-e2bc-499d-b46b-1f29856bce4f" ], "Companies": [ "a3855373-e982-4d0b-a7ac-87595a9b9364", "a217cf01-e2df-4cb4-974c-383347c7c247" ], "Groups": [ "691012d4-7ee0-414b-a4fc-1d92c1de328f", "07d745fc-fe2e-4f9e-8437-b28db10c1782" ], "Opportunities": [ "d43c460c-edf0-46b8-983d-a5c853a20495", "e23e071d-0b4c-442a-a14a-4fe17c3bab1d" ] } }, { "HasAttachment": true, "Attachment": { "DisplayName": "sample string 1", "FileSize": 2.1, "LastModified": "2024-05-04T07:19:23Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-04T07:19:23Z", "CreateDate": "2024-05-04T07:19:23Z", "DisplayDate": "2024-05-04T07:19:23Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "6681575b-e26a-449e-b232-ef2c6936c210", "ManageUserID": "a3052784-4974-44bc-93de-c38f599ec2b5", "ManageUserName": "sample string 9", "CreateUserID": "8db9bf8b-1e36-4662-80e1-da444e9fa3d3", "CreateUserName": "sample string 11", "EditUserID": "4f50ffb7-41fb-453f-a89d-eda0aabed60f", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "92dafec0-2b8a-4016-a2c2-ec811e08778d", "f8ec787f-e2bc-499d-b46b-1f29856bce4f" ], "Companies": [ "a3855373-e982-4d0b-a7ac-87595a9b9364", "a217cf01-e2df-4cb4-974c-383347c7c247" ], "Groups": [ "691012d4-7ee0-414b-a4fc-1d92c1de328f", "07d745fc-fe2e-4f9e-8437-b28db10c1782" ], "Opportunities": [ "d43c460c-edf0-46b8-983d-a5c853a20495", "e23e071d-0b4c-442a-a14a-4fe17c3bab1d" ] } } ]