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": "24a4d4e8-1b95-4d92-85cb-eb0da5cf29e4",
"Asset": {
"AssetId": "e56e13d1-e12f-47b4-9b2d-494aa1730836",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b979b28d-664e-4e8b-9351-5dcf27a3671f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a4e36f70-7282-423b-a89e-04c7081b1281",
"CreateDate": "2025-12-17T04:27:13.6289954-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.6289954-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "fd8881b7-4404-41a3-ad07-0c0638c7762f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-17T04:27:13.6446162-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:13.6446162-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b4f65bcf-fa1e-4f9e-b4ad-d384aba0dc4b",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "50536eac-280b-4b6e-9f9d-b7d8ee64fa3c",
"EffectiveDate": "2025-12-17T04:27:13.6446162-08:00",
"StateType": {
"StateTypeId": "424cea69-0cfc-4958-a2d8-c26a2ec329ea",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b979b28d-664e-4e8b-9351-5dcf27a3671f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a4e36f70-7282-423b-a89e-04c7081b1281",
"CreateDate": "2025-12-17T04:27:13.6289954-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.6289954-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b52c4711-5316-4fcb-912a-e5accf04d224",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7f96a68b-55d0-4766-8050-708f6508f1b1",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b1af934e-b0e6-4389-b5f6-e1984480a1cb",
"EffectiveDate": "2025-12-17T04:27:13.6446162-08:00",
"StatusType": {
"StatusTypeId": "c5083c1f-9234-4200-ae92-52336d99b719",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b979b28d-664e-4e8b-9351-5dcf27a3671f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a4e36f70-7282-423b-a89e-04c7081b1281",
"CreateDate": "2025-12-17T04:27:13.6289954-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.6289954-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2b4d9a51-596f-4e60-85cc-4406303012f2",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "26eb6f98-dffd-418b-8647-4d4cd3c7b687",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d96ca73d-f5f7-471e-90db-f56d6824aa7d",
"EffectiveDate": "2025-12-17T04:27:13.6446162-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "10b8cfe9-ac77-47af-bd30-957b7266b540",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "59923089-4faa-4099-a06f-aa491a63d95d",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46005919-dfbd-42b5-bc97-a695ebe30f51",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-17T04:27:13.6446162-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:13.6446162-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "be3c7d38-153e-427e-91cd-3ff53091f5e8",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ff20b71f-c6da-4048-ae74-0f6b9e3825ea",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e8dcf37c-fe84-4c9d-b14e-e45abd5d6d4c",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-17T04:27:13.6446162-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6719e4b3-e349-4197-8ad4-9dd6202521a4",
"CreateDate": "2025-12-17T04:27:13.6446162-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.6446162-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}