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": "2e02ba18-43b2-442f-8934-8d567c2b9f29",
"Asset": {
"AssetId": "a2770e61-0075-4302-a040-ee347806d765",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "35ea64cd-7c76-4c4b-a882-d8f7954ce444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6d5833f-887b-452b-88aa-394dd0f61f38",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "199d8a60-7aac-46e9-9da9-cec5c752ab2e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-23T00:13:01.6464975-08:00",
"MeasurementValueNeededDate": "2024-11-23T00:13:01.6464975-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "284abecf-163a-4a71-8ab6-cf9c1c468574",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "699110dc-7e09-4831-9ad0-203be1147ab9",
"EffectiveDate": "2024-11-23T00:13:01.6464975-08:00",
"StateType": {
"StateTypeId": "a2102b80-e924-483a-9b00-61e020833c3c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "35ea64cd-7c76-4c4b-a882-d8f7954ce444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6d5833f-887b-452b-88aa-394dd0f61f38",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9ec7533a-4748-4c60-a9cb-7b7edbe1d368",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e0d8d9e6-5219-487a-b0f7-55819c9567c4",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "050522e1-de25-429e-a266-1ba12e4d2752",
"EffectiveDate": "2024-11-23T00:13:01.6464975-08:00",
"StatusType": {
"StatusTypeId": "84de40dc-63fe-4b63-bbd9-a084ff7e801b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "35ea64cd-7c76-4c4b-a882-d8f7954ce444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6d5833f-887b-452b-88aa-394dd0f61f38",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "402d9f2d-597a-4fe8-98ba-ca69dbd40f21",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "951389df-195c-4474-a327-a1e1faf9a6e7",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "989e8a5c-d758-4d9c-9f34-6083835eaa4b",
"EffectiveDate": "2024-11-23T00:13:01.6464975-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "9a8053cb-c803-4637-802c-71fc4691faeb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3b7d9bbb-720b-4444-9191-9ac0828c5957",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bd166068-2098-49ad-b7ab-de0a8eb104da",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-11-23T00:13:01.6464975-08:00",
"MeasurementValueNeededDate": "2024-11-23T00:13:01.6464975-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "53f476b8-5d16-41a2-bc28-cab9bb0125f4",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3417ba03-07ee-4af9-9528-7a33d8f2c6c0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a97f80f2-85f4-4b00-b08a-a20fc43b9176",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-11-23T00:13:01.6464975-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7f87617c-766e-4ef7-9114-4a5b71ba0315",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "2e02ba18-43b2-442f-8934-8d567c2b9f29",
"Asset": {
"AssetId": "a2770e61-0075-4302-a040-ee347806d765",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "35ea64cd-7c76-4c4b-a882-d8f7954ce444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6d5833f-887b-452b-88aa-394dd0f61f38",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "199d8a60-7aac-46e9-9da9-cec5c752ab2e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-23T00:13:01.6464975-08:00",
"MeasurementValueNeededDate": "2024-11-23T00:13:01.6464975-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "284abecf-163a-4a71-8ab6-cf9c1c468574",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "699110dc-7e09-4831-9ad0-203be1147ab9",
"EffectiveDate": "2024-11-23T00:13:01.6464975-08:00",
"StateType": {
"StateTypeId": "a2102b80-e924-483a-9b00-61e020833c3c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "35ea64cd-7c76-4c4b-a882-d8f7954ce444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6d5833f-887b-452b-88aa-394dd0f61f38",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9ec7533a-4748-4c60-a9cb-7b7edbe1d368",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e0d8d9e6-5219-487a-b0f7-55819c9567c4",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "050522e1-de25-429e-a266-1ba12e4d2752",
"EffectiveDate": "2024-11-23T00:13:01.6464975-08:00",
"StatusType": {
"StatusTypeId": "84de40dc-63fe-4b63-bbd9-a084ff7e801b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "35ea64cd-7c76-4c4b-a882-d8f7954ce444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6d5833f-887b-452b-88aa-394dd0f61f38",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "402d9f2d-597a-4fe8-98ba-ca69dbd40f21",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "951389df-195c-4474-a327-a1e1faf9a6e7",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "989e8a5c-d758-4d9c-9f34-6083835eaa4b",
"EffectiveDate": "2024-11-23T00:13:01.6464975-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "9a8053cb-c803-4637-802c-71fc4691faeb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3b7d9bbb-720b-4444-9191-9ac0828c5957",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bd166068-2098-49ad-b7ab-de0a8eb104da",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-11-23T00:13:01.6464975-08:00",
"MeasurementValueNeededDate": "2024-11-23T00:13:01.6464975-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "53f476b8-5d16-41a2-bc28-cab9bb0125f4",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3417ba03-07ee-4af9-9528-7a33d8f2c6c0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a97f80f2-85f4-4b00-b08a-a20fc43b9176",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-11-23T00:13:01.6464975-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7f87617c-766e-4ef7-9114-4a5b71ba0315",
"CreateDate": "2024-11-23T00:13:01.6464975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-23T00:13:01.6464975-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}