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": "6a3630a5-3733-45c9-b836-0e0cbde7c71e",
"Asset": {
"AssetId": "479a76e4-255a-4dcb-974b-b2f0532fff35",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8ab9022d-b6c1-4c5f-aad0-7f364e2c1d29",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8b805d27-9ed4-46b0-a27d-3dd8feb50510",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1a2b8b6e-39ef-496f-8b45-382934ad8490",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T20:27:45.6204092-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:45.6204092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3d1a6c3f-4ebe-41c8-9762-aa550f172b9d",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "216c9533-5e4f-4ad6-ba68-580ec885692f",
"EffectiveDate": "2026-06-01T20:27:45.6204092-07:00",
"StateType": {
"StateTypeId": "68c6827c-050b-402f-913c-94cab82028e9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8ab9022d-b6c1-4c5f-aad0-7f364e2c1d29",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8b805d27-9ed4-46b0-a27d-3dd8feb50510",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4b22363a-a164-425a-abad-aaaffc7a2c76",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "69ee2945-30b9-4eb8-9f9b-afa25edd470c",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d4210bea-0d17-402d-90f1-d027de60270c",
"EffectiveDate": "2026-06-01T20:27:45.6204092-07:00",
"StatusType": {
"StatusTypeId": "9a5948cc-f547-44c3-a5a6-4c939b585e6f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8ab9022d-b6c1-4c5f-aad0-7f364e2c1d29",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8b805d27-9ed4-46b0-a27d-3dd8feb50510",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4527441e-0919-4cd6-96ed-e4d227237f66",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c87137ce-0f27-4c5e-9ac5-202658c34cb6",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "25518b80-6c2e-450c-8f36-b793895fa58f",
"EffectiveDate": "2026-06-01T20:27:45.6204092-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "16f3a371-6a0e-46d8-8ebc-000a5cebfacc",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9c2e87e1-1cba-45f3-8636-39d8af9e507d",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5c951357-5233-42a1-b261-a39468a6b3f3",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-01T20:27:45.6204092-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:45.6204092-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a0463e40-11f0-448d-8cd9-1d7ad02c1298",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4c25c5f0-27eb-4012-9081-5364bdbce5b8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "18d15cd6-744e-424f-9bd3-399e60a4a60c",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-01T20:27:45.6204092-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b715ce0b-02f0-44d3-8c1a-ce1440d6c1ee",
"CreateDate": "2026-06-01T20:27:45.6204092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:45.6204092-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}