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-12-05T02:14:21Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-12-05T02:14:21Z", "CreateDate": "2024-12-05T02:14:21Z", "DisplayDate": "2024-12-05T02:14:21Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "d9feb213-00ae-4cee-8322-0286ea0372e6", "ManageUserID": "4f167f76-5e89-4170-9dcb-37cde7a7c2d7", "ManageUserName": "sample string 9", "CreateUserID": "5189efbf-75c1-400f-8967-c18ece1f711c", "CreateUserName": "sample string 11", "EditUserID": "e85d1a41-6a09-4653-8d98-1407fb4b881e", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "60ed9985-5fbe-4f07-a226-d3e1254cc6ef", "728f8df5-4e6a-46ac-b74f-1acc512710a1" ], "Companies": [ "d1151e7c-5dac-42f6-b289-2c8eba19b949", "17916824-4a6f-49ce-9e90-8db0fce95118" ], "Groups": [ "d3dc1b3a-cc03-4aa8-927a-0c1296ae622a", "e9f8893a-7d2c-46f5-bc8b-1a70df6be63b" ], "Opportunities": [ "b1b27e7e-7497-49e7-823d-fe84bef31d1a", "962a5d5a-5aca-460a-94a9-4e7eacd5999e" ] } }