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": "2e8576c8-f9e0-4b9b-9b9f-f0a458085d6c",
"Asset": {
"AssetId": "a127f1b0-b006-4b8b-ad4d-f71d5032ff1e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c3a727e7-9ebd-46b7-856f-e991dbb7f7e6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a44f530a-d925-428c-b44d-5b1ea341cdb0",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9548e09d-9e8c-4590-92e1-7166a668c6c5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T17:54:24.9431613-07:00",
"MeasurementValueNeededDate": "2026-06-13T17:54:24.9431613-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6913cde6-80f0-45e6-8371-72e71adafa34",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-13T17:54:24.9431613-07:00",
"MeasurementValueNeededDate": "2026-06-13T17:54:24.9431613-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "366f6d37-0049-4a05-88be-70acdeb4baa0",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "230fb87d-bf51-45b3-aea9-73da2d1fbd6e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f08ce2b1-5aa6-4906-9b5b-d20b3e44b868",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-13T17:54:24.9431613-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8decccf0-75ee-41ff-a04f-acf933d65cd1",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "2e8576c8-f9e0-4b9b-9b9f-f0a458085d6c",
"Asset": {
"AssetId": "a127f1b0-b006-4b8b-ad4d-f71d5032ff1e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c3a727e7-9ebd-46b7-856f-e991dbb7f7e6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a44f530a-d925-428c-b44d-5b1ea341cdb0",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9548e09d-9e8c-4590-92e1-7166a668c6c5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T17:54:24.9431613-07:00",
"MeasurementValueNeededDate": "2026-06-13T17:54:24.9431613-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6913cde6-80f0-45e6-8371-72e71adafa34",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-13T17:54:24.9431613-07:00",
"MeasurementValueNeededDate": "2026-06-13T17:54:24.9431613-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "366f6d37-0049-4a05-88be-70acdeb4baa0",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "230fb87d-bf51-45b3-aea9-73da2d1fbd6e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f08ce2b1-5aa6-4906-9b5b-d20b3e44b868",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-13T17:54:24.9431613-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8decccf0-75ee-41ff-a04f-acf933d65cd1",
"CreateDate": "2026-06-13T17:54:24.9431613-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T17:54:24.9431613-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}