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-19T02:42:48Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-19T02:42:48Z", "CreateDate": "2024-05-19T02:42:48Z", "DisplayDate": "2024-05-19T02:42:48Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "f1cdd8a1-6c50-4b48-985f-035406ae92af", "ManageUserID": "8dbbc7d0-283f-42b0-80b5-2c2dda7667b4", "ManageUserName": "sample string 9", "CreateUserID": "4e7be656-e6f1-4d58-8401-5d00078f9b06", "CreateUserName": "sample string 11", "EditUserID": "0fee5366-82e5-490a-b197-fe7ad21a1726", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "147670df-ddd9-496e-a3ef-d8b3b21736bd", "6368cbef-b5a6-4368-ac44-ef3f16c905ac" ], "Companies": [ "d4540987-d47d-4a84-9ad7-1bd4e7c87596", "e2ba4ba0-8ad2-4743-8181-dd9232e2536f" ], "Groups": [ "58e1922f-fcbf-47ea-9391-c42560d8a141", "72f9d097-e0cc-41e6-b906-ec6e69b39d4a" ], "Opportunities": [ "69364066-ef79-455d-8755-e890aeb657be", "ecbc01b2-ae99-4996-9448-3694f83a02c4" ] } }