PUT Notes
Updates the given note.
Request Information
URI Parameters
None.
Body Parameters
The note to update
Note| Name | Description | Type | Additional information |
|---|---|---|---|
| NoteId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| NoteCategory | NoteCategory |
None. |
|
| EffectiveDate | date |
None. |
|
| NoteHTML | string |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"NoteId": "3d7c71b8-ca97-47af-96c4-719fea02040e",
"Asset": {
"AssetId": "f988180e-b421-41eb-99d8-1dbcb2577aad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ec5f9118-b784-4dec-9d5e-4009e95bb47a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b4842f6e-2ac3-404c-9574-6e92f6d18249",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "81838b23-9714-4e57-8fc3-a8831af43b40",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-31T18:00:51.1075879-08:00",
"MeasurementValueNeededDate": "2025-12-31T18:00:51.1075879-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "967a10b9-5df0-4fe8-8c4c-405bdff5f82b",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-31T18:00:51.1075879-08:00",
"MeasurementValueNeededDate": "2025-12-31T18:00:51.1075879-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d0bf1ff1-32fa-45e3-a4fe-fba74591889b",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2be02f8f-733f-40b9-9e9b-c5bdfa038514",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1ec00125-cbc4-40df-a850-1a14e56342f7",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-31T18:00:51.1075879-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c46a56f6-bd10-47af-909e-e8534475a25d",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 5"
}
Response Information
Resource Description
On success, the updated note.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"NoteId": "f937e26d-a9c4-40e0-8f1b-c41e7dd56987",
"Asset": {
"AssetId": "54bc989e-de2d-434b-8ad3-d1e88a4612e8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "00633d36-8a96-4235-912a-14d49f1cca8b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3148d0e1-b118-48fc-8ef1-2d1f60a32517",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4aaa3e5b-2a0f-4d0a-a6f7-f1ce66596788",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-31T18:00:51.1075879-08:00",
"MeasurementValueNeededDate": "2025-12-31T18:00:51.1075879-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "87029a39-79a4-47a4-9839-16fca5901989",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-31T18:00:51.1075879-08:00",
"MeasurementValueNeededDate": "2025-12-31T18:00:51.1075879-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e9269dd1-e84a-497c-9aac-8ed34e4ba725",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b437c85f-60db-4700-9ece-9b78cd27e892",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bc59be4e-805d-4151-b1a7-789003eb12b8",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-31T18:00:51.1075879-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "33c79d50-7429-4282-8e1f-8c8631cf4be1",
"CreateDate": "2025-12-31T18:00:51.1075879-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-31T18:00:51.1075879-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}