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": "f0dc8080-ca92-4308-b9fa-e9577188752c",
"Asset": {
"AssetId": "3f2042f8-606b-4575-b16c-efe4467084c2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7c5deb2c-a776-4d3a-adfb-0ea8748bb022",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "54a1cff7-9a44-4ba1-9994-17ecb385d2cb",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9526e233-6a06-4f82-b611-0a7b134b3406",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-13T23:37:08.1314909-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:37:08.1314909-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4243783e-0341-4b69-a968-c78392f86495",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a98cc035-0d77-4c5e-b54c-c68aa5714f0d",
"EffectiveDate": "2026-09-13T23:37:08.1314909-07:00",
"StateType": {
"StateTypeId": "ebed2f69-c053-4792-a303-74a7c50550a6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7c5deb2c-a776-4d3a-adfb-0ea8748bb022",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "54a1cff7-9a44-4ba1-9994-17ecb385d2cb",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6eacc876-c86b-442e-84b7-c21c12c30d45",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b3f954ed-87d0-47ab-8a7f-f406626d6c16",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1bfd27db-bfa2-48eb-b002-fc23cb1c888c",
"EffectiveDate": "2026-09-13T23:37:08.1314909-07:00",
"StatusType": {
"StatusTypeId": "b774d9ef-86c2-4471-935c-72426659dde3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7c5deb2c-a776-4d3a-adfb-0ea8748bb022",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "54a1cff7-9a44-4ba1-9994-17ecb385d2cb",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1f68d08e-afad-49c7-b494-1ab30bd0b709",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "81b00734-2f2e-4d0e-94cc-c2043214d853",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cf06cf8b-fad8-4fdf-a862-394691addb43",
"EffectiveDate": "2026-09-13T23:37:08.1314909-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b0a4b8a7-6cd2-48bc-95ba-3973b8f5a029",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a08e0331-69cd-47b6-b1cd-60953a75a8a1",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e2a424dd-99a2-47ca-92ac-cd7d05528453",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-13T23:37:08.1314909-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:37:08.1314909-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "911c281f-9098-4d17-aa6c-44e47c8ee165",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "62303293-4066-4b88-a690-98b53af03826",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b68f814c-a68e-4102-b2c6-5a695d036d8a",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-13T23:37:08.1314909-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fffa4a42-2525-42be-a90e-4ddddc4bb5d5",
"CreateDate": "2026-09-13T23:37:08.1314909-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:37:08.1314909-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}