GET api/Notes
Get all notes in the database. Supported Headers: SelectField, Filter, Sort, Take, Skip, SortDesc, IncludeLink, DetailFormat
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of 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-18T23:49:51Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-18T23:49:51Z", "CreateDate": "2024-05-18T23:49:51Z", "DisplayDate": "2024-05-18T23:49:51Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "968f4b1b-ced0-4934-ac0d-3a8043ab15a9", "ManageUserID": "b976a85d-4d93-4218-9b49-55dedec658b3", "ManageUserName": "sample string 9", "CreateUserID": "1776b6a7-9b72-40f1-9283-492da20ffba1", "CreateUserName": "sample string 11", "EditUserID": "b103876f-15b4-4dc3-b494-1b52b7209032", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "68b20c23-afb1-4074-a8a2-852826b7a1dc", "e81be8b2-223f-44fc-a1df-671c615792a9" ], "Companies": [ "dfac043a-64ee-420b-9612-7811e3363d53", "7d37f65d-8791-44c5-9723-9767b29a1ac8" ], "Groups": [ "ecd13df5-2e4d-41ff-be11-c07dbaacc4b4", "9bfb561e-a8fc-4d37-a57b-864db4179d0e" ], "Opportunities": [ "43688d0a-6222-495f-ade8-b49939e104e1", "bccfee86-356c-4ccc-99e0-ca023e907d39" ] } }, { "HasAttachment": true, "Attachment": { "DisplayName": "sample string 1", "FileSize": 2.1, "LastModified": "2024-05-18T23:49:51Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-18T23:49:51Z", "CreateDate": "2024-05-18T23:49:51Z", "DisplayDate": "2024-05-18T23:49:51Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "968f4b1b-ced0-4934-ac0d-3a8043ab15a9", "ManageUserID": "b976a85d-4d93-4218-9b49-55dedec658b3", "ManageUserName": "sample string 9", "CreateUserID": "1776b6a7-9b72-40f1-9283-492da20ffba1", "CreateUserName": "sample string 11", "EditUserID": "b103876f-15b4-4dc3-b494-1b52b7209032", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "68b20c23-afb1-4074-a8a2-852826b7a1dc", "e81be8b2-223f-44fc-a1df-671c615792a9" ], "Companies": [ "dfac043a-64ee-420b-9612-7811e3363d53", "7d37f65d-8791-44c5-9723-9767b29a1ac8" ], "Groups": [ "ecd13df5-2e4d-41ff-be11-c07dbaacc4b4", "9bfb561e-a8fc-4d37-a57b-864db4179d0e" ], "Opportunities": [ "43688d0a-6222-495f-ade8-b49939e104e1", "bccfee86-356c-4ccc-99e0-ca023e907d39" ] } } ]