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-15T18:05:01Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-15T18:05:01Z", "CreateDate": "2024-05-15T18:05:01Z", "DisplayDate": "2024-05-15T18:05:01Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "dc18b6b8-0bba-437d-827a-1073b2826de2", "ManageUserID": "67dab539-2952-481c-bece-66aec4763f2d", "ManageUserName": "sample string 9", "CreateUserID": "47425b36-207c-4ed8-952e-c1e4648162c7", "CreateUserName": "sample string 11", "EditUserID": "cde1bfa6-cf13-4886-9fe1-01079817507d", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "c0c14712-c33f-4578-9b35-fcbb2cf51cae", "4c26a9f3-7c46-4344-8b6a-762754945033" ], "Companies": [ "7c6615ab-e6df-4c24-920a-5b71e114e6a8", "8c6e6d49-9bbc-4937-8004-c8010432570d" ], "Groups": [ "43f4ecfb-e952-4e34-9413-b4505a27c7b6", "bde8c267-18b5-46a2-8d53-1f5f5b373449" ], "Opportunities": [ "a693e08b-4f67-4747-835e-78b22e00d612", "8719a4cf-2a91-4a07-8cd4-fad88b7962eb" ] } }