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": "520db422-9772-4807-8dae-03c1133f710c",
"Asset": {
"AssetId": "bb4c8a5e-862d-4e19-8bf7-4cc8818b0b25",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6a8101fe-7717-4463-95b4-341a02580cd1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "38aae226-5c67-49db-a6c6-c41ae9c8befb",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f4d33ddd-243e-4ae3-976b-9e0cf2ffee67",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T04:43:50.7814299-08:00",
"MeasurementValueNeededDate": "2026-02-23T04:43:50.7814299-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9152bc7f-3d5f-4714-8f1f-56981bdc7572",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "300d7c0a-ce9e-42f7-b755-f15757a1cf1b",
"EffectiveDate": "2026-02-23T04:43:50.7814299-08:00",
"StateType": {
"StateTypeId": "4784d674-5bd4-48e3-8b92-9bb342cf42c7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6a8101fe-7717-4463-95b4-341a02580cd1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "38aae226-5c67-49db-a6c6-c41ae9c8befb",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "693fec7f-73cc-4fd1-8b24-c8e80f871be6",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6e2af8af-0f0a-4c41-858d-482c21a420fd",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0e81151d-7afb-45ea-a816-a2a3c237f986",
"EffectiveDate": "2026-02-23T04:43:50.7814299-08:00",
"StatusType": {
"StatusTypeId": "ccebbfc7-a665-4166-a026-d2c1ad25cbb9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6a8101fe-7717-4463-95b4-341a02580cd1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "38aae226-5c67-49db-a6c6-c41ae9c8befb",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b626c64a-4d14-4c0d-9609-9e664596c268",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "25b51baf-7079-41c0-aa3c-24b8e748a872",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "46338cb9-da99-4c67-bcfe-fb03066d7e46",
"EffectiveDate": "2026-02-23T04:43:50.7814299-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "c5dc3463-4094-46cd-823c-a6c0fed50f6a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c92fce76-e7fa-4f65-9c63-98dd3c917f9f",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "31a231b1-7103-4abb-ae05-a161ff83d5e1",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-23T04:43:50.7814299-08:00",
"MeasurementValueNeededDate": "2026-02-23T04:43:50.7814299-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "202a5b40-24ab-4ff8-80a4-def08efd8ae5",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "e29082c8-c07a-47c0-a113-5962f5972778",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "82f25be1-ab06-4745-a275-b89acac6558d",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-23T04:43:50.7814299-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3a898c1b-ab74-4f2f-a3a5-d9cbb1188b96",
"CreateDate": "2026-02-23T04:43:50.7814299-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T04:43:50.7814299-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}