GET api/Notes/{id}
Get Note by Id. Supported Headers: SelectField, IncludeLink, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
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-04T05:38:06Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-04T05:38:06Z", "CreateDate": "2024-05-04T05:38:06Z", "DisplayDate": "2024-05-04T05:38:06Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "28eea94b-0f16-4b27-a73f-66ad3df01f3c", "ManageUserID": "0b982083-ae2f-4571-b717-fdf883f45ae9", "ManageUserName": "sample string 9", "CreateUserID": "44bb58a3-68c0-478a-9acb-a596ef32dca7", "CreateUserName": "sample string 11", "EditUserID": "8bfe1421-3866-4bfe-bc0a-07054eccdf19", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "9e66a889-3d1d-44ed-8dfc-411aa84d062c", "88319c6e-4845-44eb-a603-ca8e7f285357" ], "Companies": [ "76344b04-0f34-45c4-884d-ce6c76a25685", "77ee7166-a31e-4cff-9aae-ef4e6caa9678" ], "Groups": [ "84bff456-9bb1-47a7-975c-e74fdbe382cc", "95133e35-e522-4c55-bb43-e4c4011a6ebd" ], "Opportunities": [ "71baa03d-7e41-46b9-95a9-2b50d807132d", "b7f1b1eb-17bb-478c-a0b1-e0ba42b0678a" ] } }