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": "9f23d2da-a87b-4886-a59d-c34576050827",
"Asset": {
"AssetId": "f17610dc-d6cd-42a6-bfd5-bce35e7cfe4f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "68f5f629-9c4f-4042-a2d8-9d40b0159054",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "100f09c1-dcb2-43a0-812c-a8e2d506722f",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "920f7e02-457e-49f4-8942-4a0c8f1618e3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-30T12:52:53.5019024-07:00",
"MeasurementValueNeededDate": "2025-08-30T12:52:53.5019024-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "975cb5b7-73ca-4279-b3e4-ed37fbc44b55",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-30T12:52:53.5019024-07:00",
"MeasurementValueNeededDate": "2025-08-30T12:52:53.5019024-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "56a54f44-1caf-4d93-805d-a683423e0eae",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "910332c8-790f-4b4c-9ed4-e7419ea4b37c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f41080d2-fdf8-493f-92f1-0921fccaa497",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-30T12:52:53.5019024-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5126f10-ea7e-42a2-8edb-5017569bba66",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07: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": "835e11b7-9f12-46e1-b73a-f7d21c7ee000",
"Asset": {
"AssetId": "b5e204c8-ab1b-4f81-aba5-d22fe9af588c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1c212ea0-b1d9-4e85-bdcd-2072fa53b8f4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "46074fbd-8b07-4030-a9d7-6cbe3838a760",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "2943fae4-99ab-4ffe-90e2-d3ce5d7b52ea",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-30T12:52:53.5019024-07:00",
"MeasurementValueNeededDate": "2025-08-30T12:52:53.5019024-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9f8d9717-49e8-4d8b-849d-94762b59fe53",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-30T12:52:53.5019024-07:00",
"MeasurementValueNeededDate": "2025-08-30T12:52:53.5019024-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ba0cc495-ce30-427c-8854-54040a008549",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "82643cef-8034-480d-9b72-4e0ddcfaf72e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a6dff7e9-4f6e-4be7-9bce-492c0a2e3a7a",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-30T12:52:53.5019024-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c4ad4726-0f37-42d9-8ef1-99e2c630e499",
"CreateDate": "2025-08-30T12:52:53.5019024-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T12:52:53.5019024-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}