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": "63e47661-4b79-436c-a466-582c1e00a055",
"Asset": {
"AssetId": "4dc2eca9-0e18-4e31-9922-31c624622e39",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b718fc97-5c91-4562-a8d7-1fdcf0a8042b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8abe18a7-9e06-4996-a3d1-bf32d10b0879",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ff98a057-1899-4f27-8072-238e5005a7e2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-24T10:00:10.3727519-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:00:10.3727519-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "782dc900-0f53-4b60-b154-55e94620ba01",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-24T10:00:10.3727519-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:00:10.3727519-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2d81acec-df01-40d2-b081-444c0f090373",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "6f6d0244-dd92-4753-8961-f86c7c27d524",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "151edd46-e2b9-416a-980e-7173abe3f932",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-24T10:00:10.3727519-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2f5ef90e-5479-4cef-a324-b4ab2e8892b4",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-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": "ad6d7175-71a3-4ece-b8cc-5ee0ee1fa6af",
"Asset": {
"AssetId": "57bc4cad-9ecb-4122-a578-20c3e6743daa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bc5bdc3c-f6f7-4204-9d0c-577a9df82e75",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7d35af63-d914-47d4-8b6f-f85cf346962a",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0fed3bec-6d90-4c12-84b0-529a90d68f13",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-24T10:00:10.3727519-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:00:10.3727519-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "15c2d58f-aee6-4b7c-90b2-9ca8ac9811c5",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-24T10:00:10.3727519-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:00:10.3727519-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "01446bd2-145c-42d4-a6c4-8d212a30bdbe",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "976b0025-7e7e-4bcd-80fd-afa4e306bca6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d0ce5c5c-fe09-424b-b783-1e99c01ede55",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-24T10:00:10.3727519-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c39ccb4d-b36f-46db-84f4-251d38197366",
"CreateDate": "2025-08-24T10:00:10.3727519-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:00:10.3727519-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}