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": "edd20c2b-efa9-4571-a865-58be80ea92b0", "Asset": { "AssetId": "4ba4d6b6-3aa2-42a3-b69b-0a048a507e51", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e878a884-0749-4a59-9205-879f3988ef98", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "94613924-aa14-44ec-a3fe-156b8edd646b", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "7c3682f8-3340-4117-b990-5fb998e64f79", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:24:13.1873391-07:00", "MeasurementValueNeededDate": "2025-05-09T01:24:13.1873391-07:00", "SourceSystemId": "sample string 3", "CompanyId": "72ac00e5-9bb5-4d6d-9ee5-48cd1bb67176", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-09T01:24:13.1873391-07:00", "MeasurementValueNeededDate": "2025-05-09T01:24:13.1873391-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "edfe50e8-fbab-4083-b897-9d07467d816b", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "0834ac8c-f811-4082-a144-c5e29ad1da15", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "c2e8ba2c-bb35-4278-8e10-98393f40b473", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-05-09T01:24:13.1873391-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "70b473f6-1cdf-4ac9-945b-aac93c69a97f", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "edd20c2b-efa9-4571-a865-58be80ea92b0", "Asset": { "AssetId": "4ba4d6b6-3aa2-42a3-b69b-0a048a507e51", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e878a884-0749-4a59-9205-879f3988ef98", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "94613924-aa14-44ec-a3fe-156b8edd646b", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "7c3682f8-3340-4117-b990-5fb998e64f79", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:24:13.1873391-07:00", "MeasurementValueNeededDate": "2025-05-09T01:24:13.1873391-07:00", "SourceSystemId": "sample string 3", "CompanyId": "72ac00e5-9bb5-4d6d-9ee5-48cd1bb67176", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-09T01:24:13.1873391-07:00", "MeasurementValueNeededDate": "2025-05-09T01:24:13.1873391-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "edfe50e8-fbab-4083-b897-9d07467d816b", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "0834ac8c-f811-4082-a144-c5e29ad1da15", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "c2e8ba2c-bb35-4278-8e10-98393f40b473", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-05-09T01:24:13.1873391-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "70b473f6-1cdf-4ac9-945b-aac93c69a97f", "CreateDate": "2025-05-09T01:24:13.1873391-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T01:24:13.1873391-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }