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": "f7d59877-5bed-42fe-9df1-7868da0c77c1",
"Asset": {
"AssetId": "8ddb88c3-5066-4306-a9e4-163177bd66e0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "faf8dc1a-0d9d-4392-8d45-2ade5ab5b68a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b2d41688-16ad-4a4c-b2e0-6cb6ab1c0601",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9cdcfd93-6a88-413f-b1bd-df52a124ac97",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T02:39:49.4156799-07:00",
"MeasurementValueNeededDate": "2026-10-04T02:39:49.4156799-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cd23152b-3aec-40f5-b9d3-e8e3770b36f5",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "79f415f6-fd47-4273-a6e0-01bb489a599d",
"EffectiveDate": "2026-10-04T02:39:49.4156799-07:00",
"StateType": {
"StateTypeId": "a95a4b58-9818-483d-9e71-705e256f4b24",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "faf8dc1a-0d9d-4392-8d45-2ade5ab5b68a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b2d41688-16ad-4a4c-b2e0-6cb6ab1c0601",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "17efaf80-ad46-4f1e-8839-961e4665a6a0",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f7743549-6dc3-475b-b8d7-df5ddd7bdd8c",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7d1421a6-e4db-47f7-8055-5ad5f7ef5741",
"EffectiveDate": "2026-10-04T02:39:49.4156799-07:00",
"StatusType": {
"StatusTypeId": "d806ba4d-3899-4359-858a-54921732313a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "faf8dc1a-0d9d-4392-8d45-2ade5ab5b68a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b2d41688-16ad-4a4c-b2e0-6cb6ab1c0601",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5522bd06-7660-4cc8-abee-8aa79246d30c",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4e5a3102-0476-485a-8937-8a7cf500ed8a",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c6a1ca46-6462-477c-bc8d-eab695009d4f",
"EffectiveDate": "2026-10-04T02:39:49.4156799-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c623740d-f642-4cbd-a659-701476a471ff",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f100bf86-945b-415c-a161-488ede2651e7",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4aa332b3-6651-4268-b901-84f43fd38907",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-04T02:39:49.4156799-07:00",
"MeasurementValueNeededDate": "2026-10-04T02:39:49.4156799-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8f21fe2c-e96d-4445-b704-c94fb9649a9e",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7f76c703-bd99-4026-97ed-0b8dc9324cd4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e8caf089-9087-4705-b5b7-c1fce7a637d5",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-04T02:39:49.4156799-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "af290e2e-7441-49bf-ad11-3a10513efaff",
"CreateDate": "2026-10-04T02:39:49.4156799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:49.4156799-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}