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": "07fb9a9d-8fc0-42d8-ba43-cd76ab21c9cd",
"Asset": {
"AssetId": "f57b5629-769c-48ce-95a8-f8c009877f38",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1c3ac020-c71f-4475-a38d-be3b5b30383f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "42986211-47ba-4efd-b659-298085b4342b",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0bb47f33-66cf-44a9-b2ed-0ee121cc8fde",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T07:48:54.8845652-08:00",
"MeasurementValueNeededDate": "2025-02-05T07:48:54.8845652-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "075f58ce-0c73-4980-a101-740eb9c293ae",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T07:48:54.8845652-08:00",
"MeasurementValueNeededDate": "2025-02-05T07:48:54.8845652-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "666ae36b-265b-4fff-a38f-15d4a4a35138",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "18f6cef8-0359-4d49-a581-64ff59989fca",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4cf40492-16d0-4463-95ea-e564f4ff4295",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T07:48:54.8845652-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "15ca4acc-503a-41e0-b196-5f6c6c86bc3b",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "07fb9a9d-8fc0-42d8-ba43-cd76ab21c9cd",
"Asset": {
"AssetId": "f57b5629-769c-48ce-95a8-f8c009877f38",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1c3ac020-c71f-4475-a38d-be3b5b30383f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "42986211-47ba-4efd-b659-298085b4342b",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0bb47f33-66cf-44a9-b2ed-0ee121cc8fde",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T07:48:54.8845652-08:00",
"MeasurementValueNeededDate": "2025-02-05T07:48:54.8845652-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "075f58ce-0c73-4980-a101-740eb9c293ae",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T07:48:54.8845652-08:00",
"MeasurementValueNeededDate": "2025-02-05T07:48:54.8845652-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "666ae36b-265b-4fff-a38f-15d4a4a35138",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "18f6cef8-0359-4d49-a581-64ff59989fca",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4cf40492-16d0-4463-95ea-e564f4ff4295",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T07:48:54.8845652-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "15ca4acc-503a-41e0-b196-5f6c6c86bc3b",
"CreateDate": "2025-02-05T07:48:54.8845652-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T07:48:54.8845652-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}