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": "a881a1eb-53ca-4f68-a011-6f66346c7d13",
"Asset": {
"AssetId": "1a45ae7e-88f4-4a2e-8269-167f4fea0dd1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "840b46ec-5e7b-469f-8fa0-9f55e9be914e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "09441e6b-ec4e-4a19-affe-360f43248c5d",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ef9e5879-ce11-438c-965f-d8f8807bd371",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-23T22:46:39.0639746-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:46:39.0639746-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b062845f-7126-4a6c-add1-75cc77797ca6",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-23T22:46:39.0639746-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:46:39.0639746-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8fecd49a-e423-470a-85b5-faeea66e1ce9",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ed483ba1-654b-4a55-b4c3-0da4100d72e4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7d7e28b6-de1b-4af6-8862-651715e53c10",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-23T22:46:39.0639746-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "19493086-1d57-408b-a9da-6cab9680dd39",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-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": "d9c15880-abc1-44df-bead-aef8c218df6f",
"Asset": {
"AssetId": "37ea5a7a-9567-4cf1-9978-d3e8162fc9e7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ee3743b3-8f40-4399-8e63-94085d85608a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c78701d1-9d26-47fe-b2bb-627b37ead8ad",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9463fbbe-cf28-4708-af5f-ac6799bb771d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-23T22:46:39.0639746-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:46:39.0639746-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6ae3757-bf60-45b6-9190-26d3d8fa39ab",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-23T22:46:39.0639746-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:46:39.0639746-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "75693d75-37a5-40f1-b342-30069a448823",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b84d8c00-9d16-4eef-91dd-882e0baf72d3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ba63b263-6b1a-4c2e-bae3-bc55f43d9db5",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-23T22:46:39.0639746-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7856b8f5-999d-41f0-953a-34fa20ac1404",
"CreateDate": "2025-08-23T22:46:39.0639746-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:46:39.0639746-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}