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": "5524f7b9-0443-48d9-ab39-9c22beca6a5f",
"Asset": {
"AssetId": "1687c4c2-b029-498c-ba05-408797f570d5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6716e0e0-2960-4485-8dd2-bb426c89763d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "20241ad7-85ff-4f82-82dd-818974134c0c",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fe9827a4-b947-43c8-9ed1-cc30b81cbe81",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-05T06:13:37.6218778-08:00",
"MeasurementValueNeededDate": "2025-12-05T06:13:37.6218778-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cfb8e1d8-d25f-42f1-ae61-3c90848dd9d3",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-05T06:13:37.6218778-08:00",
"MeasurementValueNeededDate": "2025-12-05T06:13:37.6218778-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bc314728-24d6-4e39-be09-2f8337864298",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f80d92af-6dd4-4fa9-94b4-ee560a595346",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ac611909-a25e-4cd1-9770-eb03503a5c84",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-05T06:13:37.6218778-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "87c0666d-defa-4cb3-a7a6-94ab3590dbaf",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-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": "ca28d055-59df-40a1-bd84-cd7a1f4cb452",
"Asset": {
"AssetId": "b9a6b016-7cab-4ce6-babb-a9e5a6749436",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0d4a95f6-c297-4122-8413-898e0b2acaad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "36283b9a-3cd6-4499-bf2f-f3c84183b6c4",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c8401057-94b8-4772-9a73-c7c440209735",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-05T06:13:37.6218778-08:00",
"MeasurementValueNeededDate": "2025-12-05T06:13:37.6218778-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8241c69d-c7e6-47cd-a006-a4d3da2ae0b9",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-05T06:13:37.6218778-08:00",
"MeasurementValueNeededDate": "2025-12-05T06:13:37.6218778-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e6660ab8-9527-4729-8dde-b3fa87e05ff3",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ce4561c8-ca6b-4391-a911-3db2cc5dc36b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "75a775fc-e3b1-4612-acbc-01aa65512d53",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-05T06:13:37.6218778-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5210c3c-1d77-468e-9e16-e2aa9bdcde57",
"CreateDate": "2025-12-05T06:13:37.6218778-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-05T06:13:37.6218778-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}