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": "b2563a99-704c-4c09-bab9-127ee01abd65",
"Asset": {
"AssetId": "ea060c0f-99ee-4855-920b-4b1524b3a740",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "83d025ae-889b-4fd3-a288-bcd6bc720b43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fb12065f-4d0e-44ba-aa15-ee91a825864f",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "15ed4850-0779-4b96-b279-2ea29fc967b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T17:09:39.2851801-08:00",
"MeasurementValueNeededDate": "2025-11-04T17:09:39.2851801-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c19b802b-4f5f-4b3b-b1ff-eb29d7961c2b",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "9b9aeeca-32e9-43c2-aaf3-ffbaa0dfda4b",
"EffectiveDate": "2025-11-04T17:09:39.2851801-08:00",
"StateType": {
"StateTypeId": "1e091ac7-b0d6-4078-a6be-197beb881903",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "83d025ae-889b-4fd3-a288-bcd6bc720b43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fb12065f-4d0e-44ba-aa15-ee91a825864f",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b78d91e3-56f8-4313-ac70-49b3a79d4f48",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fe09880c-87ab-416f-9a58-089954bb61bb",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "73a40013-0e65-4a5e-b4c0-97080bca02a1",
"EffectiveDate": "2025-11-04T17:09:39.2851801-08:00",
"StatusType": {
"StatusTypeId": "4a435e9e-6433-4c70-9059-78a775063378",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "83d025ae-889b-4fd3-a288-bcd6bc720b43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fb12065f-4d0e-44ba-aa15-ee91a825864f",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "15a1e5c3-4ca5-4dee-84fd-58440392acf2",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4feee4ef-3f1f-4484-a7eb-167a83c19d6b",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6530e043-c870-4eda-93f1-44df9e30040f",
"EffectiveDate": "2025-11-04T17:09:39.2851801-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "3089cdb6-df82-450b-88cf-59569506a869",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7032a0aa-5c18-445c-90c1-8a328e517162",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6a4233f8-0c9d-476e-9bec-2996509d8c25",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T17:09:39.2851801-08:00",
"MeasurementValueNeededDate": "2025-11-04T17:09:39.2851801-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9efa5425-68c4-4cd6-abd0-d9026e56820e",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6e947064-b0e4-4f02-8a72-8f75c564dc8a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7a69f08d-f488-46ba-be74-47a7043822d5",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-04T17:09:39.2851801-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "855f98d4-c5a7-4c5a-9ab1-3d544c8c015c",
"CreateDate": "2025-11-04T17:09:39.2851801-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T17:09:39.2851801-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}