Retrieves the note with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The note id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the note, or 404 Not Found if it doesn't exist.
db_notes| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| db_table_id |
Table Id db notes linked to |
globally unique identifier |
Optionally required : db_table_id or db_table_name must be provided |
| id_in_table |
Item id on the given table on which db note linked to |
globally unique identifier |
Required |
| user_id |
Created User ID |
globally unique identifier |
Optionally required : user_id, user_code or user must be provided |
| date_add |
Date Added. Auto-filled by NOW if empty |
date | |
| dateutc_add |
Date UTC Added |
date | |
| notes |
Notes |
string |
Required |
| source_db_table_id |
Identifier of the database table this note originated from, when generated via integration/automation. |
globally unique identifier | |
| source_id_in_table |
Primary key of the source record (in the table identified by ) this note originated from. |
globally unique identifier | |
| updated_by_user_id |
Foreign key of the user who last updated this note. |
globally unique identifier | |
| date_update |
Local date and time this note was last updated. |
date | |
| dateutc_update |
UTC date and time this note was last updated. |
date | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "06790160-eb9b-4352-bdc0-c522f4955eb3",
"db_table_id": "3cdd627c-572d-4cbe-bb3c-0a062306b7d0",
"id_in_table": "f3c6eb90-6bb2-4bbe-a396-a6d9fcf38c14",
"user_id": "9f0f4a04-3bcc-48e5-8b07-67bf428eaa2c",
"date_add": "2026-11-12T14:27:39.1810533+00:00",
"dateutc_add": "2026-11-12T14:27:39.1810533+00:00",
"notes": "sample string 7",
"source_db_table_id": "61809eaa-7cfb-443b-aa1e-46f4cec3938d",
"source_id_in_table": "75797914-7ed1-44b1-a30c-644a58e4a452",
"updated_by_user_id": "4a04dd55-4d33-4a01-a167-264857216988",
"date_update": "2026-11-12T14:27:39.1810533+00:00",
"dateutc_update": "2026-11-12T14:27:39.1810533+00:00",
"modified_dateutc": "2026-11-12T14:27:39.1810533+00:00"
}
application/xml, text/xml
<db_notes xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <date_add>2026-11-12T14:27:39.181Z</date_add> <date_update>2026-11-12T14:27:39.181Z</date_update> <dateutc_add>2026-11-12T14:27:39.181Z</dateutc_add> <dateutc_update>2026-11-12T14:27:39.181Z</dateutc_update> <db_table_id>3cdd627c-572d-4cbe-bb3c-0a062306b7d0</db_table_id> <id>06790160-eb9b-4352-bdc0-c522f4955eb3</id> <id_in_table>f3c6eb90-6bb2-4bbe-a396-a6d9fcf38c14</id_in_table> <modified_dateutc>2026-11-12T14:27:39.181Z</modified_dateutc> <notes>sample string 7</notes> <source_db_table_id>61809eaa-7cfb-443b-aa1e-46f4cec3938d</source_db_table_id> <source_id_in_table>75797914-7ed1-44b1-a30c-644a58e4a452</source_id_in_table> <updated_by_user_id>4a04dd55-4d33-4a01-a167-264857216988</updated_by_user_id> <user_id>9f0f4a04-3bcc-48e5-8b07-67bf428eaa2c</user_id> </db_notes>