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": "8ca7ee4c-5223-4e29-8845-302cfff12894",
"Asset": {
"AssetId": "a01792ac-ca63-4cd8-97f6-13c474e1c55a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f0d45edd-3c82-461e-8d3e-bb4328406981",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3b08966-54ef-40af-a78b-a6f09bce5f8a",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e688bdf8-5614-40f7-b6c8-b1ac0c7229c0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-12T17:05:39.9284521-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:05:39.9284521-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c316519f-df35-4f3e-870f-f1db80ba7713",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "db98c1b8-bf46-4090-9ee4-3c365cd4f7ff",
"EffectiveDate": "2026-05-12T17:05:39.9284521-07:00",
"StateType": {
"StateTypeId": "8c91f9d0-a20d-4aed-bd7c-e3ada1aa139c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f0d45edd-3c82-461e-8d3e-bb4328406981",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3b08966-54ef-40af-a78b-a6f09bce5f8a",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c754a03c-b6ab-493f-95a6-9a8e7a17cfc4",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "50cd725c-8f31-48b5-b209-35a6dbca7d7e",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5ddbd23b-680a-40a7-b9e6-a88b07f1edec",
"EffectiveDate": "2026-05-12T17:05:39.9284521-07:00",
"StatusType": {
"StatusTypeId": "a79e2c20-6e35-41b2-a6ea-3a7ae54e12f0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f0d45edd-3c82-461e-8d3e-bb4328406981",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3b08966-54ef-40af-a78b-a6f09bce5f8a",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3d36a1b1-85a8-49b7-909e-a1637e4c1607",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9af675e9-ce78-45c8-bee5-8484b9261ae1",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d14e237b-1c3e-4190-912c-3c566eaf8ac2",
"EffectiveDate": "2026-05-12T17:05:39.9284521-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3c02fb45-cc01-48f0-a135-c78266dc9ab1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7f0a82c5-c826-489e-aca1-d1e2532f74c4",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6dd8a661-4ba8-4406-bbfc-12f667cb85ce",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-12T17:05:39.9284521-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:05:39.9284521-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1428ec1c-a241-47f0-9245-ccf9b40ea367",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9a605940-9980-49ad-b7af-9cb026789e02",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "da7e25a2-9d89-410e-82f7-29d478c0e19d",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-12T17:05:39.9284521-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "83222284-59ef-481c-b646-1f43942c14e3",
"CreateDate": "2026-05-12T17:05:39.9284521-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:39.9284521-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}