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": "57b479f4-b19f-4235-8c0d-952e6e0463d3",
"Asset": {
"AssetId": "732e50ab-7777-4616-96fd-ed68b72b30e9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "90029af4-dd9a-4fef-a49b-bdbbc98dd418",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3e13f69e-590f-4c3b-9e0a-4f8243802401",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "89adc9f0-6197-42cc-823b-8359d58b29b2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-27T09:33:06.0614488-08:00",
"MeasurementValueNeededDate": "2025-12-27T09:33:06.0614488-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2d600ed-0e7e-4ac8-803f-04faa4855b10",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-27T09:33:06.0614488-08:00",
"MeasurementValueNeededDate": "2025-12-27T09:33:06.0614488-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6eb40388-5679-43a2-aa40-b15fffe3e9a7",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a008831d-6534-4e6e-80b8-de8ec8bcd30c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "eda7d5d4-bd7c-4977-8fa4-94a2e8718570",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-27T09:33:06.0614488-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dbc8d666-eca3-45fd-8d0d-f81d0670f81e",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "57b479f4-b19f-4235-8c0d-952e6e0463d3",
"Asset": {
"AssetId": "732e50ab-7777-4616-96fd-ed68b72b30e9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "90029af4-dd9a-4fef-a49b-bdbbc98dd418",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3e13f69e-590f-4c3b-9e0a-4f8243802401",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "89adc9f0-6197-42cc-823b-8359d58b29b2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-27T09:33:06.0614488-08:00",
"MeasurementValueNeededDate": "2025-12-27T09:33:06.0614488-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2d600ed-0e7e-4ac8-803f-04faa4855b10",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-27T09:33:06.0614488-08:00",
"MeasurementValueNeededDate": "2025-12-27T09:33:06.0614488-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6eb40388-5679-43a2-aa40-b15fffe3e9a7",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a008831d-6534-4e6e-80b8-de8ec8bcd30c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "eda7d5d4-bd7c-4977-8fa4-94a2e8718570",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-27T09:33:06.0614488-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dbc8d666-eca3-45fd-8d0d-f81d0670f81e",
"CreateDate": "2025-12-27T09:33:06.0614488-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-27T09:33:06.0614488-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}