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": "b431b612-abf0-4e9e-a2ed-b58086892f49",
"Asset": {
"AssetId": "294c59be-16ca-4db7-a46d-c3865cbaa50b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "825b4de0-7b83-44c4-904b-33bdcd126b56",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c74557ed-dc5c-4b6f-a212-5c7cf01773b9",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "be4c22b7-987f-4983-9998-1350fed84de6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T08:07:33.0584522-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:07:33.0584522-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5c134ba-f3c5-42c1-a046-566abfd6f44f",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ab101996-388b-45f2-b3b5-7b485223057a",
"EffectiveDate": "2026-11-01T08:07:33.0584522-08:00",
"StateType": {
"StateTypeId": "8908cd95-c9e0-41f7-bd7c-8a39abe89942",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "825b4de0-7b83-44c4-904b-33bdcd126b56",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c74557ed-dc5c-4b6f-a212-5c7cf01773b9",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "57f6e960-7d2b-4ee2-ae6b-284e3a9bc7c1",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "10402cfc-51e9-42e3-9f0a-6c8ab95fca48",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ed4a2677-f054-411e-afb7-ad5ffd03af31",
"EffectiveDate": "2026-11-01T08:07:33.0584522-08:00",
"StatusType": {
"StatusTypeId": "324970ca-f096-4cbc-8fba-5aed502d2ade",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "825b4de0-7b83-44c4-904b-33bdcd126b56",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c74557ed-dc5c-4b6f-a212-5c7cf01773b9",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9b0e04a9-c846-42bb-8875-982ab16f1aaf",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "29436c18-0323-4c62-87b1-707e896047ad",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2fcdf8d8-98f1-4a01-8490-f4f87e7f3d2d",
"EffectiveDate": "2026-11-01T08:07:33.0584522-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "20a64a10-67cb-4127-bae0-82db44157dee",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4e532d8a-1705-4828-a78a-7ad1d0e8f494",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9c15d3c3-6627-4c36-a051-76185a4469b6",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-01T08:07:33.0584522-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:07:33.0584522-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6e4ff10d-91c2-430a-ac95-b9f2a5d29a06",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a4787ac6-1f26-4314-bb84-6d21785103a9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "468c5d32-b7e6-4f60-8ff6-818fb1256b35",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-01T08:07:33.0584522-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7f48f9c9-a7b1-40d8-8bad-02d2e6f3da58",
"CreateDate": "2026-11-01T08:07:33.0584522-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:07:33.0584522-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}