GET Notes/ByEffectiveDate?assetId={assetId}&beginDate={beginDate}&endDate={endDate}
Retrieves notes for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetId |
Id of the asset |
globally unique identifier |
None. |
| beginDate |
Beginning effective date of the notes to retrieve |
date |
None. |
| endDate |
Ending effective date of the notes to retrieve |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of notes.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"NoteId": "6b47f702-cf2f-45fb-b0e7-40433addda0f",
"Asset": {
"AssetId": "ad4e3d6d-9f33-4152-8ed5-3b8670a7c23f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "59c54b0c-ac02-4a05-b425-ce8dae931633",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c537ba3e-dc10-42d0-a277-7556e5272491",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "837be6cf-8928-4aaf-9d04-ff0cc9f9b98d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:13:01.8944941-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:13:01.8944941-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3d5ddb53-7578-4d5f-a185-76b6e2e47b72",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ceb22c76-3505-4553-bfbf-36b3ec47fb9d",
"EffectiveDate": "2026-11-22T14:13:01.8944941-08:00",
"StateType": {
"StateTypeId": "0f47b9eb-8b93-416b-bb55-f90c66a7aecc",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "59c54b0c-ac02-4a05-b425-ce8dae931633",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c537ba3e-dc10-42d0-a277-7556e5272491",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f0e2e029-3703-4de0-bf1d-8bdc0df8b2ab",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c98baca8-5a03-45a3-9a3a-f27b443905b8",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "020fbd4a-7201-4577-9840-15831f1f67b0",
"EffectiveDate": "2026-11-22T14:13:01.8944941-08:00",
"StatusType": {
"StatusTypeId": "056b4d1e-c21c-4bf3-99cb-0ac87a352dce",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "59c54b0c-ac02-4a05-b425-ce8dae931633",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c537ba3e-dc10-42d0-a277-7556e5272491",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e922acff-0535-414c-a181-b874b7d7c2f0",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4cde82b9-37c0-4b50-b2f4-d52bd34cc92f",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "389523e6-e586-4f4a-919c-38d69c056af6",
"EffectiveDate": "2026-11-22T14:13:01.8944941-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "1d7931df-9f39-4081-9b60-02b88d83335e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a878c159-1c92-46eb-bf9c-666be762665e",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e26f61ba-bea9-4773-8976-59fbe367c0c5",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:13:01.8944941-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:13:01.8944941-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9c03a3a4-4eb6-490b-9d92-9ffe3db474e5",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9658f184-600a-4e80-a54b-a2a12bdac1c9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bcd1fabe-a460-4ff7-a30b-3f6927243b83",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-22T14:13:01.8944941-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2238900d-49d0-4299-b127-fa08a78a9737",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "6b47f702-cf2f-45fb-b0e7-40433addda0f",
"Asset": {
"AssetId": "ad4e3d6d-9f33-4152-8ed5-3b8670a7c23f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "59c54b0c-ac02-4a05-b425-ce8dae931633",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c537ba3e-dc10-42d0-a277-7556e5272491",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "837be6cf-8928-4aaf-9d04-ff0cc9f9b98d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:13:01.8944941-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:13:01.8944941-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3d5ddb53-7578-4d5f-a185-76b6e2e47b72",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ceb22c76-3505-4553-bfbf-36b3ec47fb9d",
"EffectiveDate": "2026-11-22T14:13:01.8944941-08:00",
"StateType": {
"StateTypeId": "0f47b9eb-8b93-416b-bb55-f90c66a7aecc",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "59c54b0c-ac02-4a05-b425-ce8dae931633",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c537ba3e-dc10-42d0-a277-7556e5272491",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f0e2e029-3703-4de0-bf1d-8bdc0df8b2ab",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c98baca8-5a03-45a3-9a3a-f27b443905b8",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "020fbd4a-7201-4577-9840-15831f1f67b0",
"EffectiveDate": "2026-11-22T14:13:01.8944941-08:00",
"StatusType": {
"StatusTypeId": "056b4d1e-c21c-4bf3-99cb-0ac87a352dce",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "59c54b0c-ac02-4a05-b425-ce8dae931633",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c537ba3e-dc10-42d0-a277-7556e5272491",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e922acff-0535-414c-a181-b874b7d7c2f0",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4cde82b9-37c0-4b50-b2f4-d52bd34cc92f",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "389523e6-e586-4f4a-919c-38d69c056af6",
"EffectiveDate": "2026-11-22T14:13:01.8944941-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "1d7931df-9f39-4081-9b60-02b88d83335e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a878c159-1c92-46eb-bf9c-666be762665e",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e26f61ba-bea9-4773-8976-59fbe367c0c5",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:13:01.8944941-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:13:01.8944941-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9c03a3a4-4eb6-490b-9d92-9ffe3db474e5",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9658f184-600a-4e80-a54b-a2a12bdac1c9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bcd1fabe-a460-4ff7-a30b-3f6927243b83",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-22T14:13:01.8944941-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2238900d-49d0-4299-b127-fa08a78a9737",
"CreateDate": "2026-11-22T14:13:01.8944941-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.8944941-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}