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": "78c45288-920c-4dce-90a6-72649f7c1f9f",
"Asset": {
"AssetId": "f1233b39-db05-414f-a281-e59971d8a4d3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "485d9766-ca6c-4819-855a-0b46ec0f7d15",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d996eb70-88d3-4c5d-8412-96504a44db1d",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0209bbff-56b4-452c-9a68-88ce54db54d0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-04T17:28:45.2330078-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:28:45.2330078-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0558d8ef-d6ff-46c6-8b14-682acba76695",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "cfaac00e-7261-44b7-8617-3500e7d7ebec",
"EffectiveDate": "2026-08-04T17:28:45.2330078-07:00",
"StateType": {
"StateTypeId": "49afd980-7404-40c5-96b6-6a6e841a1221",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "485d9766-ca6c-4819-855a-0b46ec0f7d15",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d996eb70-88d3-4c5d-8412-96504a44db1d",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "96e13f0d-64ae-4789-9359-6692d6b8c56a",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9fce9514-34bb-4da6-89ec-ca13cd205926",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "98bdd8ba-1fbe-4ce7-97ee-b26c4489c2a3",
"EffectiveDate": "2026-08-04T17:28:45.2330078-07:00",
"StatusType": {
"StatusTypeId": "69f50be5-0800-458d-a62e-a5f6dd510fbe",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "485d9766-ca6c-4819-855a-0b46ec0f7d15",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d996eb70-88d3-4c5d-8412-96504a44db1d",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ce619305-04d0-4441-afb4-b002ac24a2a9",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1c3bb6c7-e2f6-4ae8-9bde-05dcbca47c18",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2710aa9d-39c8-4e72-b32f-2f76d0267f83",
"EffectiveDate": "2026-08-04T17:28:45.2330078-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a29ac7c9-9175-4eca-b8e2-98cc839ab031",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "af6837a3-5104-4edf-94cf-b525a31b1e79",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b191165d-3057-415f-98bc-3c153bea6c14",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-04T17:28:45.2330078-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:28:45.2330078-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "02aab131-dafd-4923-bb66-8915c6d61f6a",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3d6a7125-d1b8-4672-a077-353c30afe5f3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "94b1549e-a229-45fc-8d99-ab35feffb982",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-04T17:28:45.2330078-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ca0f2c9e-fbab-4f51-b299-59d1b8e9b441",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "78c45288-920c-4dce-90a6-72649f7c1f9f",
"Asset": {
"AssetId": "f1233b39-db05-414f-a281-e59971d8a4d3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "485d9766-ca6c-4819-855a-0b46ec0f7d15",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d996eb70-88d3-4c5d-8412-96504a44db1d",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0209bbff-56b4-452c-9a68-88ce54db54d0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-04T17:28:45.2330078-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:28:45.2330078-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0558d8ef-d6ff-46c6-8b14-682acba76695",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "cfaac00e-7261-44b7-8617-3500e7d7ebec",
"EffectiveDate": "2026-08-04T17:28:45.2330078-07:00",
"StateType": {
"StateTypeId": "49afd980-7404-40c5-96b6-6a6e841a1221",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "485d9766-ca6c-4819-855a-0b46ec0f7d15",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d996eb70-88d3-4c5d-8412-96504a44db1d",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "96e13f0d-64ae-4789-9359-6692d6b8c56a",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9fce9514-34bb-4da6-89ec-ca13cd205926",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "98bdd8ba-1fbe-4ce7-97ee-b26c4489c2a3",
"EffectiveDate": "2026-08-04T17:28:45.2330078-07:00",
"StatusType": {
"StatusTypeId": "69f50be5-0800-458d-a62e-a5f6dd510fbe",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "485d9766-ca6c-4819-855a-0b46ec0f7d15",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d996eb70-88d3-4c5d-8412-96504a44db1d",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ce619305-04d0-4441-afb4-b002ac24a2a9",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1c3bb6c7-e2f6-4ae8-9bde-05dcbca47c18",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2710aa9d-39c8-4e72-b32f-2f76d0267f83",
"EffectiveDate": "2026-08-04T17:28:45.2330078-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a29ac7c9-9175-4eca-b8e2-98cc839ab031",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "af6837a3-5104-4edf-94cf-b525a31b1e79",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b191165d-3057-415f-98bc-3c153bea6c14",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-04T17:28:45.2330078-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:28:45.2330078-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "02aab131-dafd-4923-bb66-8915c6d61f6a",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3d6a7125-d1b8-4672-a077-353c30afe5f3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "94b1549e-a229-45fc-8d99-ab35feffb982",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-04T17:28:45.2330078-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ca0f2c9e-fbab-4f51-b299-59d1b8e9b441",
"CreateDate": "2026-08-04T17:28:45.2330078-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:28:45.2330078-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}