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": "9a693793-f349-4474-beb1-a09818a1db7e", "Asset": { "AssetId": "655c34f3-ee39-4334-afb9-d51a288691ec", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b8c4865b-f1a0-4da7-9817-add97c1cf428", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "76b5fdc3-abf5-4863-a6ea-b65a8d0d86fc", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "1b8ec018-b732-45f6-a9cb-97afcce30d16", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-29T02:16:53.9267227-07:00", "MeasurementValueNeededDate": "2024-03-29T02:16:53.9267227-07:00", "SourceSystemId": "sample string 3", "CompanyId": "cca780e2-5122-48da-b853-51dcdb31c664", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-03-29T02:16:53.9267227-07:00", "MeasurementValueNeededDate": "2024-03-29T02:16:53.9267227-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f83f5a97-ddff-4587-9022-78e876d782b3", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "889e8962-f41a-4ec6-b4e4-b2ee9bf2fcee", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "3888ccaa-1342-4037-8efa-3967f2c629fd", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-03-29T02:16:53.9267227-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "85b3634f-df9f-405c-a37a-ed2708c08fc4", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "9a693793-f349-4474-beb1-a09818a1db7e", "Asset": { "AssetId": "655c34f3-ee39-4334-afb9-d51a288691ec", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b8c4865b-f1a0-4da7-9817-add97c1cf428", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "76b5fdc3-abf5-4863-a6ea-b65a8d0d86fc", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "1b8ec018-b732-45f6-a9cb-97afcce30d16", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-29T02:16:53.9267227-07:00", "MeasurementValueNeededDate": "2024-03-29T02:16:53.9267227-07:00", "SourceSystemId": "sample string 3", "CompanyId": "cca780e2-5122-48da-b853-51dcdb31c664", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-03-29T02:16:53.9267227-07:00", "MeasurementValueNeededDate": "2024-03-29T02:16:53.9267227-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f83f5a97-ddff-4587-9022-78e876d782b3", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "889e8962-f41a-4ec6-b4e4-b2ee9bf2fcee", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "3888ccaa-1342-4037-8efa-3967f2c629fd", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-03-29T02:16:53.9267227-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "85b3634f-df9f-405c-a37a-ed2708c08fc4", "CreateDate": "2024-03-29T02:16:53.9267227-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T02:16:53.9267227-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }