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": "7262c2e0-fa18-40c1-bd0f-e1c2f5306298",
"Asset": {
"AssetId": "e828ba03-83e0-4934-931d-56cb3b0d91ee",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "01ff58f7-547f-44e6-8ab3-535fba739e9e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d7f834a0-9005-4d94-a287-f25e8fc5c58b",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ed5761e7-5e21-439c-9fe0-d9da2b2f0eff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:31.4989587-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:31.4989587-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6f2e5553-765b-49b2-a020-d8de1b9f2f70",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-21T15:32:31.4989587-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:31.4989587-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9e514d58-3125-45c3-b614-b4afc4d6a45a",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d705291c-6d62-48f2-8e7a-20febb13bfc6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "30343d35-7fb3-49fd-97aa-2c81ce877617",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T15:32:31.4989587-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "724a26f6-576d-46d3-a9b0-c901046ac592",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "7262c2e0-fa18-40c1-bd0f-e1c2f5306298",
"Asset": {
"AssetId": "e828ba03-83e0-4934-931d-56cb3b0d91ee",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "01ff58f7-547f-44e6-8ab3-535fba739e9e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d7f834a0-9005-4d94-a287-f25e8fc5c58b",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ed5761e7-5e21-439c-9fe0-d9da2b2f0eff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:31.4989587-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:31.4989587-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6f2e5553-765b-49b2-a020-d8de1b9f2f70",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-21T15:32:31.4989587-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:31.4989587-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9e514d58-3125-45c3-b614-b4afc4d6a45a",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d705291c-6d62-48f2-8e7a-20febb13bfc6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "30343d35-7fb3-49fd-97aa-2c81ce877617",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T15:32:31.4989587-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "724a26f6-576d-46d3-a9b0-c901046ac592",
"CreateDate": "2026-11-21T15:32:31.4989587-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T15:32:31.4989587-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}