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": "b75a6e7f-574d-40f2-863a-73f3e2205a7b",
"Asset": {
"AssetId": "a86cd9e0-fe14-4c3f-b854-a44aff5521c3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1ee08e3e-ce56-438f-af5f-802a9a054d14",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51350008-ac04-4531-b40a-8202c5c3baf0",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8c51ba93-129e-4a19-95bd-49437c545119",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-22T01:37:41.9718013-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:37:41.9718013-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "41020d1a-a6e7-4044-b2de-a020c9042b8b",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4d0fd281-e1b3-4e2a-8fcd-427038004049",
"EffectiveDate": "2026-06-22T01:37:41.9718013-07:00",
"StateType": {
"StateTypeId": "8ff93dcd-4959-4670-b257-4b79824fcffa",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1ee08e3e-ce56-438f-af5f-802a9a054d14",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51350008-ac04-4531-b40a-8202c5c3baf0",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f2d13296-2ec8-4a6e-824d-108f1fd81358",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a3b14f2d-db1c-4d3b-8e97-8145a1bf26ce",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "23d44b7a-6204-44d6-be2b-58d37d4a6323",
"EffectiveDate": "2026-06-22T01:37:41.9718013-07:00",
"StatusType": {
"StatusTypeId": "cc55433f-d338-4c7a-aec8-06415daa78cf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1ee08e3e-ce56-438f-af5f-802a9a054d14",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "51350008-ac04-4531-b40a-8202c5c3baf0",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "399ed1a2-142e-40fd-8bed-e909470179f0",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0ba97dc8-9e67-47b9-a868-1b6f030d2947",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "41707f2e-20e7-4368-a420-b5d4a22f7135",
"EffectiveDate": "2026-06-22T01:37:41.9718013-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "7422a1f8-8c1b-442d-ab10-78bfb9cd5bee",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1a4accbf-997c-4539-9899-a750a688642d",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "76ea73ab-ab5b-4912-9acd-774b511498d8",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-22T01:37:41.9718013-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:37:41.9718013-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af2cfc9b-50c7-4970-a674-a1c093547aa3",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5b133bef-4ae2-4534-9e9e-fb99ffdceb84",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "46e30f23-7080-4935-ae7b-cae31f77eee7",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-22T01:37:41.9718013-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "adc3c72e-ff7e-4de8-bc39-f539f974d11f",
"CreateDate": "2026-06-22T01:37:41.9718013-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:37:41.9718013-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}