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": "29a03080-b27d-4471-81fd-4ccf964a1e8b",
"Asset": {
"AssetId": "4bc5ef0c-f9bd-4a42-b782-c22b68654bb4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "007998b3-c25d-4756-b427-b894753fc34c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5b8d8d1-4b44-4162-b160-129e7f4569c5",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b3d4f226-15cb-40dd-89df-6e8b1f6cff82",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-24T21:33:50.4742964-07:00",
"MeasurementValueNeededDate": "2026-08-24T21:33:50.4742964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7d73cbe-3a7e-4761-b8c1-9386cd2b8fac",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3a0780d8-ea28-4b12-bc65-a08d536bb17e",
"EffectiveDate": "2026-08-24T21:33:50.4742964-07:00",
"StateType": {
"StateTypeId": "18d49f06-d7d7-456d-bc57-c866995c83cd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "007998b3-c25d-4756-b427-b894753fc34c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5b8d8d1-4b44-4162-b160-129e7f4569c5",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "cc2df6b8-6b4d-4660-8bae-73de6d23f31f",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aeaee32b-dd0c-4095-b723-7bc5df631100",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "83c30cda-d92d-42c7-8b18-d9148a295a20",
"EffectiveDate": "2026-08-24T21:33:50.4742964-07:00",
"StatusType": {
"StatusTypeId": "dedfea80-dda9-469f-8f62-8290a4903274",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "007998b3-c25d-4756-b427-b894753fc34c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5b8d8d1-4b44-4162-b160-129e7f4569c5",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e10813a9-7c16-473b-8055-35def9d30e9a",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0a3470b6-b245-4239-8f26-6a3f641e46b4",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0c8f0da8-9306-4059-97bd-567e6f8272c2",
"EffectiveDate": "2026-08-24T21:33:50.4742964-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "09ac8be6-d226-4034-8184-802eddcca50c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cd9b25b8-9b4e-40ab-a0a7-67f5a91e6b14",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "56320934-2536-47c8-aa91-f2201f6e497d",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-24T21:33:50.4742964-07:00",
"MeasurementValueNeededDate": "2026-08-24T21:33:50.4742964-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b67834b4-9722-476b-9fac-fcaac3a15196",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "25702427-56da-4a42-b4ae-bbd09723c701",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cd08278f-94e0-4e74-b9ed-d40d38e345e4",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-24T21:33:50.4742964-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5ca781d-3c1e-4b78-846b-1c57581db1fe",
"CreateDate": "2026-08-24T21:33:50.4742964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:33:50.4742964-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}