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": "5caa6d30-1f22-4301-9413-48dac03699a2",
"Asset": {
"AssetId": "fd471d10-2ada-4771-acd5-cecccef7c0e3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "91c091b0-8c34-45a1-8cfb-6f54ecb6ae56",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98c39d41-0222-4600-ab8a-b6b4dcea26fe",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "43fd3c02-a5b8-4997-a4f3-df60e6f0aee3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-03T15:25:53.0831094-07:00",
"MeasurementValueNeededDate": "2025-04-03T15:25:53.0831094-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "befe9db9-e27a-4dbd-9337-f548a4d6693d",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-03T15:25:53.0831094-07:00",
"MeasurementValueNeededDate": "2025-04-03T15:25:53.0831094-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "883cd02b-b8c3-457f-b830-c3dd24e5d2c9",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "32c59aad-c3fd-4b7f-ad1d-405a7fb9265e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e17d5561-1b42-4d53-91af-76983c58c0a9",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-03T15:25:53.0831094-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "036be39d-910d-4402-a83e-d4f7238630f2",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "5caa6d30-1f22-4301-9413-48dac03699a2",
"Asset": {
"AssetId": "fd471d10-2ada-4771-acd5-cecccef7c0e3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "91c091b0-8c34-45a1-8cfb-6f54ecb6ae56",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98c39d41-0222-4600-ab8a-b6b4dcea26fe",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "43fd3c02-a5b8-4997-a4f3-df60e6f0aee3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-03T15:25:53.0831094-07:00",
"MeasurementValueNeededDate": "2025-04-03T15:25:53.0831094-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "befe9db9-e27a-4dbd-9337-f548a4d6693d",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-03T15:25:53.0831094-07:00",
"MeasurementValueNeededDate": "2025-04-03T15:25:53.0831094-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "883cd02b-b8c3-457f-b830-c3dd24e5d2c9",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "32c59aad-c3fd-4b7f-ad1d-405a7fb9265e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e17d5561-1b42-4d53-91af-76983c58c0a9",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-03T15:25:53.0831094-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "036be39d-910d-4402-a83e-d4f7238630f2",
"CreateDate": "2025-04-03T15:25:53.0831094-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-03T15:25:53.0831094-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}