GET Notes?noteId={noteId}
Retrieves a note by its Id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| noteId |
Id of the note |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"NoteId": "172c7294-24b4-4e94-bbdb-f000ba3cf5cb",
"Asset": {
"AssetId": "d4655a98-a1c3-4dca-8dde-c51b44778d02",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e152b979-0438-489a-98cf-caf40efe31ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5602beb3-8b2d-47de-bb6b-146d0a86d8ab",
"CreateDate": "2026-08-03T02:24:36.2399949-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-03T02:24:36.2399949-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f4dba710-b730-4ea6-adb2-ff8681f54531",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-03T02:24:36.2399949-07:00",
"MeasurementValueNeededDate": "2026-08-03T02:24:36.2399949-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c9ae0214-0b92-49c1-b847-77a1b6b5df84",
"CreateDate": "2026-08-03T02:24:36.2399949-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:24:36.2399949-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-03T02:24:36.2399949-07:00",
"MeasurementValueNeededDate": "2026-08-03T02:24:36.2399949-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3afbdc80-e4cc-4df0-97f4-70feb38e40cd",
"CreateDate": "2026-08-03T02:24:36.2399949-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-03T02:24:36.2399949-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "545cc9af-6c93-4d07-a53d-85a5ef4dfd82",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4d0c1e60-3ceb-46e7-9ab0-199025a62cf4",
"CreateDate": "2026-08-03T02:24:36.2399949-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-03T02:24:36.2399949-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-03T02:24:36.2399949-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a331c4ba-d85b-48de-9775-8750bcb0a906",
"CreateDate": "2026-08-03T02:24:36.2399949-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-03T02:24:36.2399949-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}