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": "f74262f1-796a-4cdb-94e9-46e11b610459",
"Asset": {
"AssetId": "4e2dcd71-6703-45b6-8b8f-dec21532648a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "eb97bd2b-5852-4386-ac09-95c92d70c9d3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "59d27f4b-ee3f-401b-b3f2-7736ef77e048",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ef0a9f0c-363a-4bce-ac7d-9319b5f79820",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-04T17:25:07.7158673-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:25:07.7158673-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fa2720d9-8ead-44fa-b76f-18c3a6def3e4",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3b52310e-f7c9-42ec-896a-078d5a519582",
"EffectiveDate": "2026-08-04T17:25:07.7158673-07:00",
"StateType": {
"StateTypeId": "10bfbae2-fda5-4d33-bccb-58a9cdfba94c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "eb97bd2b-5852-4386-ac09-95c92d70c9d3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "59d27f4b-ee3f-401b-b3f2-7736ef77e048",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7baaf8f7-649a-41df-9a72-ae12c4c4e043",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e3d27268-5ccc-4c3d-8171-e11ae6cb2135",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "113226a1-822d-4a24-91ce-39df3fde097a",
"EffectiveDate": "2026-08-04T17:25:07.7158673-07:00",
"StatusType": {
"StatusTypeId": "d018b6ce-0efd-451f-9ce9-fc576a84f423",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "eb97bd2b-5852-4386-ac09-95c92d70c9d3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "59d27f4b-ee3f-401b-b3f2-7736ef77e048",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6d05bdc9-1b26-4f9d-90e5-65e65d962e29",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "34f8667b-506e-4072-99f9-93114c41de42",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5dd58f9c-f857-470d-b417-51ceb16461de",
"EffectiveDate": "2026-08-04T17:25:07.7158673-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0769edf6-fd90-4627-9f7f-348c207e50e2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8fb563b7-51df-47de-b314-7a90a56de23c",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f47a81ef-08d3-4d1c-902f-58aa747de6e9",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-04T17:25:07.7158673-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:25:07.7158673-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6209c0f9-a038-46e9-a15e-d13b31929e69",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6ff34b30-62cd-4ab2-b572-b0f2248c1e37",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5d92a382-7f34-412f-bf00-321947eafb69",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-04T17:25:07.7158673-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5c7319c4-55af-443a-9efa-3ed22ea1d658",
"CreateDate": "2026-08-04T17:25:07.7158673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:25:07.7158673-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}