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": "973674bf-a8ae-4c94-996b-f659b40573b9",
"Asset": {
"AssetId": "d64e9fe5-5353-4bde-9738-52e8222f9457",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a74a0767-ce5f-46ae-855f-dcd6a9445a02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8b6eb867-041a-44ca-bf0b-8d39a813882e",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9db4bb6f-7e62-4a7b-a781-d72527eed29f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-11T11:06:23.5569912-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:06:23.5569912-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fdec83ba-dfa4-4a52-ad81-05c85426da4d",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f3f1a1f9-c7f9-41ad-b86d-d8b2e8d7e260",
"EffectiveDate": "2026-05-11T11:06:23.5569912-07:00",
"StateType": {
"StateTypeId": "5fff861d-82aa-4b44-85ac-43c2d3c1587c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a74a0767-ce5f-46ae-855f-dcd6a9445a02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8b6eb867-041a-44ca-bf0b-8d39a813882e",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4c0d6697-ff0d-4c75-94aa-90ca9210ed4a",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2ce3553f-9e8e-43df-8ad3-48b8e2f4e2d7",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "19450c8d-1f88-43ae-a18d-b81c6b766d52",
"EffectiveDate": "2026-05-11T11:06:23.5569912-07:00",
"StatusType": {
"StatusTypeId": "27779020-f5dc-4940-9e66-369f1a97efcc",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a74a0767-ce5f-46ae-855f-dcd6a9445a02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8b6eb867-041a-44ca-bf0b-8d39a813882e",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "518c9437-eaa5-4ef7-ab92-83191b431f93",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "111efefe-92f6-422e-a769-164d007b8a78",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8c617ca0-5c3a-4b55-9380-2105e415d89f",
"EffectiveDate": "2026-05-11T11:06:23.5569912-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e374a130-cbda-4007-b184-14b13216d304",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "74a600c5-08d8-4ed0-8dcd-2355a659d627",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3d4f7c06-2950-4a22-9097-94d98b3d5fa8",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-11T11:06:23.5569912-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:06:23.5569912-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8f7be50c-1a65-4714-9f89-a9533ccfb446",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3d28b358-925f-44ec-a6f0-973bb70e1821",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c5da9386-e549-4cd5-bc7d-f273f1b538d6",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-11T11:06:23.5569912-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9a1f46c3-43ad-46f1-8ac4-90da4e2decf4",
"CreateDate": "2026-05-11T11:06:23.5569912-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:06:23.5569912-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}