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": "9a8a3259-ab41-4abd-a97b-499eacfdec00",
"Asset": {
"AssetId": "59e6058a-e2d8-4eb0-885a-9f4b48fb11eb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e80b37ff-3155-46ae-add2-446eb06dd356",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da8ed3a7-b9f7-4274-849a-f95cc5b4c78f",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "619a1811-c799-48eb-89e2-0ba05809e224",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T17:58:59.697386-07:00",
"MeasurementValueNeededDate": "2026-03-15T17:58:59.697386-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1955652a-e44b-4d7a-b9fb-61455313b4d6",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "20385e74-b353-48b4-b105-918c1eb7b989",
"EffectiveDate": "2026-03-15T17:58:59.697386-07:00",
"StateType": {
"StateTypeId": "1e42f1e2-0410-48dd-861f-7d4b61bd759d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e80b37ff-3155-46ae-add2-446eb06dd356",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da8ed3a7-b9f7-4274-849a-f95cc5b4c78f",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6f6e3e37-0532-416c-b2d4-2e3b835d4a34",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fca87161-e7f1-4bf9-92cb-c8e36f708c16",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7a8ea943-5053-45f9-8c75-03fc5dad9cb5",
"EffectiveDate": "2026-03-15T17:58:59.697386-07:00",
"StatusType": {
"StatusTypeId": "f751fed5-28d7-4166-a162-b66239c132c0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e80b37ff-3155-46ae-add2-446eb06dd356",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "da8ed3a7-b9f7-4274-849a-f95cc5b4c78f",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "21a77ccd-2e2a-420f-a61f-2c2c9b11bc94",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "db6a6c6b-704e-4276-8c19-955d51db7275",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "822a16b0-4f6d-40ce-a279-6f188fb0e573",
"EffectiveDate": "2026-03-15T17:58:59.697386-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "fa8a3105-2712-49d6-951f-234f1c9bc4c0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "95fdd833-e2e2-4ff9-9b85-43f7d509c2b7",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6a4293cc-8775-45ff-a0e7-d1e44c305e59",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-15T17:58:59.697386-07:00",
"MeasurementValueNeededDate": "2026-03-15T17:58:59.697386-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e28fb94e-f83d-4928-bb3b-6ba803f72ae0",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "70bf8433-0e0d-495d-bb8a-a40708820df0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2fccca6a-b0a4-4471-ace4-4f6fd61b6f92",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-15T17:58:59.697386-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "481dfe5c-252e-4457-afcb-f6a9442f51e4",
"CreateDate": "2026-03-15T17:58:59.697386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:59.697386-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}