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": "438d7793-9dec-40cb-98ca-d43475077e93",
"Asset": {
"AssetId": "4113913d-a041-4983-bb15-28192be0b6de",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "13e052f2-ff2b-4e23-976c-154b521380ff",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cf221ebb-8d1d-4358-923d-7bb586e9155f",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8807c352-5c7d-4652-a302-208215fddbd9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-09T22:51:28.3021713-08:00",
"MeasurementValueNeededDate": "2025-12-09T22:51:28.3021713-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "67a8cbe7-f4bc-4242-9f20-cb7b59703e52",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-09T22:51:28.3021713-08:00",
"MeasurementValueNeededDate": "2025-12-09T22:51:28.3021713-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "16c464fc-9433-475c-aae4-3211bba76e92",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "9ecf94ca-fe86-4dcb-9699-66ff1e92365a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aa0e9966-43e6-492a-bacb-47bb42092582",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-09T22:51:28.3021713-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f74cea04-6ebf-4f6f-944b-8293af5f3be9",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-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": "6602aeaf-5579-4ff5-a569-1dedcdce5867",
"Asset": {
"AssetId": "5d5fb4af-e825-48fa-bfa6-8cdfe9e6517e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1ef34f30-425e-44cd-a311-9cd9941a2763",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ebd70178-fc93-4564-96a5-96cf0b4b8ead",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "dc8f410a-cfce-4b89-b591-3313d7512a7f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-09T22:51:28.3021713-08:00",
"MeasurementValueNeededDate": "2025-12-09T22:51:28.3021713-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b9ab5ffa-b05a-45c6-925b-1496f1e60f45",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-09T22:51:28.3021713-08:00",
"MeasurementValueNeededDate": "2025-12-09T22:51:28.3021713-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a33f781a-bedd-49ad-b71b-5a2324303d71",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e0dd77f8-ead0-4c0e-9040-e0dc24ec3c30",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dc7956e0-20ba-408a-9737-ed1988f2aa62",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-09T22:51:28.3021713-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7f6005e8-c29c-4985-ae5f-0abb64106f80",
"CreateDate": "2025-12-09T22:51:28.3021713-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-09T22:51:28.3021713-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}