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": "84f705bb-eab1-4f06-b6a6-eef57ee3b203",
"Asset": {
"AssetId": "eec432e6-3579-40ca-9c61-df317932e2f9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "32f2312b-bb2c-4186-afce-9cf871df2980",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "35f686da-c8b4-4ed6-ad08-d9464bdb7f0b",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "dbc53130-9f08-4295-9b59-41a1651bc61f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T06:39:25.6340052-08:00",
"MeasurementValueNeededDate": "2026-11-21T06:39:25.6340052-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "979f20f4-4b68-417f-8ce3-e4f549e9b48b",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ab6900a8-2133-46ab-a496-67f59240c5d4",
"EffectiveDate": "2026-11-21T06:39:25.6340052-08:00",
"StateType": {
"StateTypeId": "ca8e0c3e-19bd-4d7d-bc79-c6d38ef31ba8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "32f2312b-bb2c-4186-afce-9cf871df2980",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "35f686da-c8b4-4ed6-ad08-d9464bdb7f0b",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ce6a06d2-c8c0-41f9-af25-cf86a9336dd7",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7fe8b522-8ff1-4ed7-80e3-656c68bd2bf8",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5c257434-81a0-4cdd-9526-afdc3be4cec0",
"EffectiveDate": "2026-11-21T06:39:25.6340052-08:00",
"StatusType": {
"StatusTypeId": "7b13f435-37b4-4c36-9fab-70397ff211ae",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "32f2312b-bb2c-4186-afce-9cf871df2980",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "35f686da-c8b4-4ed6-ad08-d9464bdb7f0b",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "251c11ad-1ed1-4858-ae04-1021f5a295c4",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "536ce244-5fd5-4058-a1fa-44db778aeb2c",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b62faf52-d2c4-4577-9c2d-189d07bd10f8",
"EffectiveDate": "2026-11-21T06:39:25.6340052-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "eb331f3d-7800-4ebc-8419-4080a9e75221",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1c3b4278-2694-4d41-bab0-af7656b52689",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e497842c-dada-4926-af71-f636ee877b1c",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T06:39:25.6340052-08:00",
"MeasurementValueNeededDate": "2026-11-21T06:39:25.6340052-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0c236108-c280-4099-9bad-221806e15fbe",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "d1fb8e09-4dc7-4ec1-a6eb-164a413c44c8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "06518a39-3357-4198-bdd7-6a5d558612c0",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T06:39:25.6340052-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2337e30e-5ada-4c32-90ce-16871113880a",
"CreateDate": "2026-11-21T06:39:25.6340052-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T06:39:25.6340052-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}