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": "44e8f4eb-d6ee-40ea-b338-fbb6f0385b8d",
"Asset": {
"AssetId": "e5518480-d9dc-44b1-a696-b86c0f7d6bb6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b2cd314d-4ba3-448c-b0cd-2c07745211bd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "180e9459-eea4-45b6-8a6c-5412b28607f0",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bc34192f-fcea-476a-8b75-d7bca3131a72",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-07T09:05:25.3793881-08:00",
"MeasurementValueNeededDate": "2026-01-07T09:05:25.3793881-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ab7ab71a-0d4b-4333-981d-1600e0447bb4",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "81085a0c-68ec-40b8-b5ca-7016073847b9",
"EffectiveDate": "2026-01-07T09:05:25.3793881-08:00",
"StateType": {
"StateTypeId": "12bf6f43-ec56-43c4-9b2e-314d5fcb11c1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b2cd314d-4ba3-448c-b0cd-2c07745211bd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "180e9459-eea4-45b6-8a6c-5412b28607f0",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d22f3d33-72bb-471f-b6b7-0982d4cc317b",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8ac3e988-b350-4ef0-9f97-9035d73ab72e",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8ee0cb7b-8870-4082-a43e-e5d81c089a67",
"EffectiveDate": "2026-01-07T09:05:25.3793881-08:00",
"StatusType": {
"StatusTypeId": "de7da0b0-7989-4415-af11-4cddd7372298",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b2cd314d-4ba3-448c-b0cd-2c07745211bd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "180e9459-eea4-45b6-8a6c-5412b28607f0",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2eb57cf0-63e9-4c76-93db-d0e9580eaf47",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7c483ed9-c038-4e88-b7b1-8ffb92dc45c5",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6e1d25ba-9365-4a1e-8a13-c39aa650da5c",
"EffectiveDate": "2026-01-07T09:05:25.3793881-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d9ea884a-476d-4f3d-acaf-e65afcd8d380",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "18f8f50c-f9e8-4604-b1e8-2e743cb9e994",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4a323248-aebb-431f-ae14-fa614b6503ac",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-07T09:05:25.3793881-08:00",
"MeasurementValueNeededDate": "2026-01-07T09:05:25.3793881-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2bdc17df-b84b-483a-8fa5-129ca21bbe13",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a485e546-e15c-4cea-8399-f636c60e9535",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "47ad2804-5b4f-436d-8556-d9d14c2a5578",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-07T09:05:25.3793881-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "db6ddbbc-6cf0-416c-aeb2-e2527679ebae",
"CreateDate": "2026-01-07T09:05:25.3793881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:05:25.3793881-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}