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": "ec47284c-7f33-4874-a136-b84a1eebb3c7",
"Asset": {
"AssetId": "71389068-e78f-4de1-9803-c6dc673d0ea6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "31c72625-fb93-4ce3-83c1-a37c8823aa8c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef3e8461-6280-4f21-860d-290f82b0f9d0",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "fe03441b-5225-41f6-9b01-0b6a16e9b507",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:23:25.553547-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:23:25.553547-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "15f4a54e-9901-444a-a549-67fd04bb823b",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "6df7ad30-9207-47c1-a08e-1e30ae7c2a68",
"EffectiveDate": "2026-08-11T22:23:25.553547-07:00",
"StateType": {
"StateTypeId": "adac9b84-08a9-4b59-9c35-296208a88029",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "31c72625-fb93-4ce3-83c1-a37c8823aa8c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef3e8461-6280-4f21-860d-290f82b0f9d0",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a37ec43b-8c3d-4424-812c-f1d8ad4e6bf8",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f072ae97-7ee4-4057-80d6-3a35a38f1630",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "15bde233-5bf2-4ad4-a1d6-3016d372e429",
"EffectiveDate": "2026-08-11T22:23:25.553547-07:00",
"StatusType": {
"StatusTypeId": "71bea162-f63e-4c25-b198-5b6b677db737",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "31c72625-fb93-4ce3-83c1-a37c8823aa8c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef3e8461-6280-4f21-860d-290f82b0f9d0",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "97fab795-1bdd-4683-9333-88493fd7be7c",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "36218fc8-7f67-4301-a67f-e2e3ef4e1714",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1e1c7913-6d3e-4ec9-93bd-09301bebf23d",
"EffectiveDate": "2026-08-11T22:23:25.553547-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "2ee2b617-978c-4478-9fdb-ba15ee7b5f1b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4fab32d7-f3c4-4654-93f1-afbf56a7d56d",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "28d5be04-02a7-4b0b-bada-f4dce106f009",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:23:25.553547-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:23:25.553547-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f9bec307-1a3b-443c-b472-220986291e31",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3053f797-5c55-483a-9f5d-290d848468b2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bd1e3cc1-5658-4647-8d1a-6a8d5239bb69",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-11T22:23:25.553547-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9029dbf8-7753-4be3-9cdb-07b700f76cfd",
"CreateDate": "2026-08-11T22:23:25.553547-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:25.553547-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}