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": "265dadf3-5bfe-4d75-a57d-f51287352ef9",
"Asset": {
"AssetId": "ac3d3307-cc48-40cc-9e15-a4fff8df3145",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2a59b6ec-0e78-474f-8ec4-e7ba084d2471",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a48bb39a-44bc-4af2-9b9b-493c68870314",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0f9c5629-7a69-477f-8a21-02a2a6651996",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T13:20:21.055459-07:00",
"MeasurementValueNeededDate": "2026-07-15T13:20:21.055459-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "edafcf03-0aed-4da1-b941-c9fd3dc3b182",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "adcba1c9-0853-4e62-bb0e-e086ca6ddb88",
"EffectiveDate": "2026-07-15T13:20:21.055459-07:00",
"StateType": {
"StateTypeId": "18f643e8-7272-4a60-97a7-ec0ee6d6a02c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2a59b6ec-0e78-474f-8ec4-e7ba084d2471",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a48bb39a-44bc-4af2-9b9b-493c68870314",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "541c097a-82d2-4490-9184-9a83ce9ed4dd",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2dbbaa77-8f2e-4456-ad0e-0afd98ba8cac",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9fbf7625-3faf-49f3-be5f-c6582c2942f6",
"EffectiveDate": "2026-07-15T13:20:21.055459-07:00",
"StatusType": {
"StatusTypeId": "7659b77d-a5c1-47bd-b6b2-878690071680",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2a59b6ec-0e78-474f-8ec4-e7ba084d2471",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a48bb39a-44bc-4af2-9b9b-493c68870314",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ae6d3bc6-946b-43b6-badd-643dc6f7a577",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8c5b88a3-531e-49a8-a2d3-2da4e1576394",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "47f77576-9777-44e8-ac82-a949277c6cda",
"EffectiveDate": "2026-07-15T13:20:21.055459-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "137ad3e6-72fe-488e-9e8e-4f1422e5c650",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1c1bf4c4-20fa-4ae7-b8a3-ff09ca6f29ce",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6efa2d89-0c07-4e20-bb66-174cf76314ff",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-15T13:20:21.055459-07:00",
"MeasurementValueNeededDate": "2026-07-15T13:20:21.055459-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d88245ee-df1d-4446-a466-b4dd2eecccc8",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "79d9e589-bd57-4f68-9c55-e796654d83fb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "af7416e0-4e16-4e2a-ae97-42c702470c2b",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-15T13:20:21.055459-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "359b67c9-8478-49bf-8802-85c12794ff06",
"CreateDate": "2026-07-15T13:20:21.055459-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:20:21.055459-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}