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": "29159ae2-466a-4da4-a1f0-437195627b75",
"Asset": {
"AssetId": "d377e114-bbab-4366-8002-efadbe6dc0f6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "01273486-f67a-4716-8ad2-7303e7940459",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c1337c0-cc5e-4dda-8d5e-e9af50ff11ed",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3d1e727d-710d-4ef3-84d9-f03c6bc34ea5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:50.660091-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:50.660091-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "44c77eac-2e15-4658-bf67-4adfd320b807",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "6a3aa9b5-a577-40ad-94e3-4d1ad35e1e6d",
"EffectiveDate": "2026-11-22T14:12:50.660091-08:00",
"StateType": {
"StateTypeId": "ea8028aa-3591-416c-aa4e-4e12ad66f676",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "01273486-f67a-4716-8ad2-7303e7940459",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c1337c0-cc5e-4dda-8d5e-e9af50ff11ed",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6b1207ac-64a4-4ce3-ad7f-de1a293b5339",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "41d7ead2-e092-427e-af07-e9a0b446f78f",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cbac07e3-e139-44e6-8d6e-29b66aefd574",
"EffectiveDate": "2026-11-22T14:12:50.660091-08:00",
"StatusType": {
"StatusTypeId": "7a1904fc-fe43-44aa-bfd1-5d7929a0ad10",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "01273486-f67a-4716-8ad2-7303e7940459",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c1337c0-cc5e-4dda-8d5e-e9af50ff11ed",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0b552c5a-c11d-4c0e-9d31-64303c0f388d",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "79342151-4946-4352-bf50-c13c135f37c6",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c8b88e48-5c3a-4f3f-a789-f374914dab48",
"EffectiveDate": "2026-11-22T14:12:50.660091-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "2ddd0c47-046c-4ed9-b0af-62f87b981c0c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f5960364-92b1-494e-af73-5b95372bcc58",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c565ab45-3569-49b1-9fae-31226a03f0b3",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:12:50.660091-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:50.660091-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8204115b-d07f-4619-99a0-a8813645b0f0",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "80d57085-072e-44f1-a69d-fa44c3c491dd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5c00dd52-8871-4e6d-949e-504b0d7455a2",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-22T14:12:50.660091-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ed0c3447-9acd-41bb-8e00-b9dc0987e5c1",
"CreateDate": "2026-11-22T14:12:50.660091-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.660091-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}