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": "b42db090-f2f3-4d88-a755-654fc4b177ba",
"Asset": {
"AssetId": "c2a49f03-e7c8-49d5-a593-89c34ac81806",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "91cd6827-a175-4a05-a1bc-cb342883bffc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "78dc7cfe-bf53-4399-80e8-3dbfd13f671a",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "91957e14-6673-45b3-a6f8-a5b102bfbc03",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-08T18:42:47.9954458-08:00",
"MeasurementValueNeededDate": "2026-02-08T18:42:47.9954458-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "acb12e12-ecb1-4c01-8989-a087b6a2af1e",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-08T18:42:47.9954458-08:00",
"MeasurementValueNeededDate": "2026-02-08T18:42:47.9954458-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "27bb82b8-4e4b-4c36-9054-3207d1d012ab",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "569ba05d-7383-4b4f-8314-b7efde906bd1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "181da409-c9bf-4624-bcd8-df7fb030a007",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-08T18:42:47.9954458-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c27cfeb4-3146-42ca-a94f-091e0de519f2",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "b42db090-f2f3-4d88-a755-654fc4b177ba",
"Asset": {
"AssetId": "c2a49f03-e7c8-49d5-a593-89c34ac81806",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "91cd6827-a175-4a05-a1bc-cb342883bffc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "78dc7cfe-bf53-4399-80e8-3dbfd13f671a",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "91957e14-6673-45b3-a6f8-a5b102bfbc03",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-08T18:42:47.9954458-08:00",
"MeasurementValueNeededDate": "2026-02-08T18:42:47.9954458-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "acb12e12-ecb1-4c01-8989-a087b6a2af1e",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-08T18:42:47.9954458-08:00",
"MeasurementValueNeededDate": "2026-02-08T18:42:47.9954458-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "27bb82b8-4e4b-4c36-9054-3207d1d012ab",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "569ba05d-7383-4b4f-8314-b7efde906bd1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "181da409-c9bf-4624-bcd8-df7fb030a007",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-08T18:42:47.9954458-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c27cfeb4-3146-42ca-a94f-091e0de519f2",
"CreateDate": "2026-02-08T18:42:47.9954458-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-08T18:42:47.9954458-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}