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-16T00:46:28Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-16T00:46:28Z", "CreateDate": "2024-05-16T00:46:28Z", "DisplayDate": "2024-05-16T00:46:28Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "b7ed5d68-0c0f-45c5-9439-a587afc0e070", "ManageUserID": "bdbcf4b5-742a-421e-a8ca-83bad459581c", "ManageUserName": "sample string 9", "CreateUserID": "84b49bf1-3d23-4050-9f29-38dfed98eee0", "CreateUserName": "sample string 11", "EditUserID": "c9b050f7-3181-43ef-8241-3ac3cae114f7", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "c8e906f1-44e9-4193-9fbd-963024334fb2", "5b59f83a-c662-4a42-9201-0c02ff1f5617" ], "Companies": [ "dbc81a2f-453e-434b-b706-8ca5d24106c6", "024e6e8f-3c4b-49dd-b0c4-2af4d117e9b5" ], "Groups": [ "ffa4a9de-a599-4f5d-870a-4cd21d7ae14a", "e7e2f9fd-2b76-499a-994e-82ffb18dedc6" ], "Opportunities": [ "4ae1ae2d-66a1-450e-b056-5547c84138cc", "fd7e2847-f012-4d76-8402-5e9aae19a2fb" ] } }, { "HasAttachment": true, "Attachment": { "DisplayName": "sample string 1", "FileSize": 2.1, "LastModified": "2024-05-16T00:46:28Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-16T00:46:28Z", "CreateDate": "2024-05-16T00:46:28Z", "DisplayDate": "2024-05-16T00:46:28Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "b7ed5d68-0c0f-45c5-9439-a587afc0e070", "ManageUserID": "bdbcf4b5-742a-421e-a8ca-83bad459581c", "ManageUserName": "sample string 9", "CreateUserID": "84b49bf1-3d23-4050-9f29-38dfed98eee0", "CreateUserName": "sample string 11", "EditUserID": "c9b050f7-3181-43ef-8241-3ac3cae114f7", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "c8e906f1-44e9-4193-9fbd-963024334fb2", "5b59f83a-c662-4a42-9201-0c02ff1f5617" ], "Companies": [ "dbc81a2f-453e-434b-b706-8ca5d24106c6", "024e6e8f-3c4b-49dd-b0c4-2af4d117e9b5" ], "Groups": [ "ffa4a9de-a599-4f5d-870a-4cd21d7ae14a", "e7e2f9fd-2b76-499a-994e-82ffb18dedc6" ], "Opportunities": [ "4ae1ae2d-66a1-450e-b056-5547c84138cc", "fd7e2847-f012-4d76-8402-5e9aae19a2fb" ] } } ]