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": "7f16d9ce-1ab1-4a89-b1d1-14d8b44ff30a",
"Asset": {
"AssetId": "c88a711d-5032-4446-ae9d-b71c5cf96b9d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e652d4f1-2ff9-4bed-bec8-4c24ba79b381",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4e2667df-4e07-4a12-a285-ce53c6584c1a",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "26a910f5-eb6a-4610-9123-d0b99451680a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T12:49:52.6187876-08:00",
"MeasurementValueNeededDate": "2026-02-02T12:49:52.6187876-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b080686e-a50f-4aac-817e-bc5f24fb7ac5",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "40d04568-6ccb-46ee-8aaf-ce5de69e0363",
"EffectiveDate": "2026-02-02T12:49:52.6187876-08:00",
"StateType": {
"StateTypeId": "1b84dd66-658d-4d91-a2aa-f730f0bfc434",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e652d4f1-2ff9-4bed-bec8-4c24ba79b381",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4e2667df-4e07-4a12-a285-ce53c6584c1a",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "173829fc-eff1-4d68-84a7-218da8e44028",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cffb9fbe-b5ab-4864-ab06-4da61e7d71f7",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d272b12b-eaac-4eff-a070-a648c8a06508",
"EffectiveDate": "2026-02-02T12:49:52.6187876-08:00",
"StatusType": {
"StatusTypeId": "a3a730bc-231c-4c4f-b942-398ad29663a4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e652d4f1-2ff9-4bed-bec8-4c24ba79b381",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4e2667df-4e07-4a12-a285-ce53c6584c1a",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9b12ae41-2ca2-42cc-aa5a-0a700eb0ed00",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "92355aa7-ccf0-4fba-99e3-bf9a6979eff0",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "046e0841-a1f2-491c-a3cb-b20dbc467d63",
"EffectiveDate": "2026-02-02T12:49:52.6187876-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "05daeb1f-931c-454d-b9de-ad23e7a42a2f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "90f1a186-3233-473a-b5c1-a17abb4d15e4",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bace532f-f0f5-4b17-817a-bd711bef0968",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T12:49:52.6187876-08:00",
"MeasurementValueNeededDate": "2026-02-02T12:49:52.6187876-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ebc03a3d-0793-4801-9108-69cb7f82940a",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ca1c4ab5-f0eb-41cc-9656-20df2fb394da",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cd9c3169-d49b-4fc4-8757-29ee22c7ba23",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-02T12:49:52.6187876-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "94f15c72-37a4-42cc-b3ee-cae791f64b05",
"CreateDate": "2026-02-02T12:49:52.6187876-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T12:49:52.6187876-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}