Retrieves the note with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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

Sample:
{
  "id": "e077235a-afaf-4556-b2d2-ce6eccc2a096",
  "db_table_id": "97f9dc7a-5729-4fd2-939e-90be6b56579d",
  "id_in_table": "40b45f77-b3cc-4c97-a7a1-2eb62201e6d0",
  "user_id": "709b443f-2e26-4d1b-b0f8-10901f20e4a4",
  "date_add": "2026-09-16T08:35:10.023914+00:00",
  "dateutc_add": "2026-09-16T08:35:10.023914+00:00",
  "notes": "sample string 7",
  "source_db_table_id": "15f9db51-da04-44f7-b5f2-e3f65bb9db3a",
  "source_id_in_table": "deef3317-cbe5-4781-be10-ac2d3205a074",
  "updated_by_user_id": "39c8db83-7aea-4a8e-b801-872147825410",
  "date_update": "2026-09-16T08:35:10.023914+00:00",
  "dateutc_update": "2026-09-16T08:35:10.023914+00:00",
  "modified_dateutc": "2026-09-16T08:35:10.023914+00:00"
}

application/xml, text/xml

Sample:
<db_notes xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <date_add>2026-09-16T08:35:10.023Z</date_add>
  <date_update>2026-09-16T08:35:10.023Z</date_update>
  <dateutc_add>2026-09-16T08:35:10.023Z</dateutc_add>
  <dateutc_update>2026-09-16T08:35:10.023Z</dateutc_update>
  <db_table_id>97f9dc7a-5729-4fd2-939e-90be6b56579d</db_table_id>
  <id>e077235a-afaf-4556-b2d2-ce6eccc2a096</id>
  <id_in_table>40b45f77-b3cc-4c97-a7a1-2eb62201e6d0</id_in_table>
  <modified_dateutc>2026-09-16T08:35:10.023Z</modified_dateutc>
  <notes>sample string 7</notes>
  <source_db_table_id>15f9db51-da04-44f7-b5f2-e3f65bb9db3a</source_db_table_id>
  <source_id_in_table>deef3317-cbe5-4781-be10-ac2d3205a074</source_id_in_table>
  <updated_by_user_id>39c8db83-7aea-4a8e-b801-872147825410</updated_by_user_id>
  <user_id>709b443f-2e26-4d1b-b0f8-10901f20e4a4</user_id>
</db_notes>