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": "87e99ef7-9d59-488f-8842-ed45ac12ec2a",
"Asset": {
"AssetId": "dfb833e7-2d60-4d30-9b9a-c1d34b477d26",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e42b6675-ec49-4cb4-9322-14182a2801c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d7504c5e-0760-44ac-9d10-0e93da53d297",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "db5ae6cc-27cf-4a29-86d8-13a00e0ba982",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-17T18:51:14.5690563-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:51:14.5690563-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "99caf62f-3d3c-4973-bf5c-9f1354e2a1bc",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "61cb76bf-7e68-4d24-adc9-638c7d0f11a7",
"EffectiveDate": "2025-11-17T18:51:14.5690563-08:00",
"StateType": {
"StateTypeId": "b33671ee-254d-4ea5-9f0c-d2afbcd01115",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e42b6675-ec49-4cb4-9322-14182a2801c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d7504c5e-0760-44ac-9d10-0e93da53d297",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f7a67b9c-cf9a-4de9-8755-2436a3c8d9d2",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f5ebcef6-b618-4824-9063-d1af743e07da",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b550473e-105f-4194-9295-97c7586e2a73",
"EffectiveDate": "2025-11-17T18:51:14.5690563-08:00",
"StatusType": {
"StatusTypeId": "c4264397-5443-4062-bfbb-3898759b00bb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e42b6675-ec49-4cb4-9322-14182a2801c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d7504c5e-0760-44ac-9d10-0e93da53d297",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "528231da-3e15-4db6-8341-a65e4e05bea6",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "62464ff2-57f5-4e38-a112-e3c5f713ba18",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4412013e-9bc9-44c0-bc66-662c39a60b5a",
"EffectiveDate": "2025-11-17T18:51:14.5690563-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "24e90d25-0c31-430a-ab44-c1469d29acf3",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a9d03ea9-05cb-4c54-98ef-50d6d39358d5",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a4af4acf-d385-4352-bfa3-48e943aa654e",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-17T18:51:14.5690563-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:51:14.5690563-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a8a2ea72-f753-4511-b3ae-c3db5a2dcdb5",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "dcacd467-3df1-4215-98d7-4ba349ca741a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bbea47fe-dccc-4793-a02f-f053122b3ebb",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-17T18:51:14.5690563-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "61ce9192-de1d-4378-b4fe-12af072d9a2e",
"CreateDate": "2025-11-17T18:51:14.5690563-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.5690563-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}