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-08T01:48:03Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-08T01:48:03Z", "CreateDate": "2024-05-08T01:48:03Z", "DisplayDate": "2024-05-08T01:48:03Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "42481bf6-6ddc-47f1-a66b-e793eea30176", "ManageUserID": "70bbc93c-b76e-49a4-83c7-0a5b475773c5", "ManageUserName": "sample string 9", "CreateUserID": "e4aa87ea-95ca-41be-bbb5-e3a2c2e55474", "CreateUserName": "sample string 11", "EditUserID": "d6c989e5-9f31-42cf-aafd-9cdb3d98d306", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "b46df21f-5f93-44f8-be26-ae066c493563", "95247dae-2703-4f43-bffb-a0ccf8348beb" ], "Companies": [ "e9e364fc-4651-4579-87fd-8104386d1325", "4f351882-e5d8-4826-89f9-79fcd01ae3ee" ], "Groups": [ "bfc78fe6-80a2-4e5e-a14f-79dee273d9b2", "f83b2bee-701b-4d2f-b618-e69aab3aea69" ], "Opportunities": [ "b49acac9-c7e4-4f5b-8ae5-ed9f300ec804", "8e1763e1-a097-4501-b910-384836de3191" ] } }