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": "51185a1c-b699-4a33-8dcd-793cfaaee983",
"Asset": {
"AssetId": "da32421a-45f3-4fe1-9a46-7f919ded4b13",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2184b8c4-05e3-4827-b462-32ee57618824",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c6318b78-630b-4ee3-ae1f-873886fd9326",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "79062cf5-f07c-4f96-b262-767b61c1ee53",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:47:34.4113486-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:47:34.4113486-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0235a1a3-8f0b-4789-a01f-671a600e1a3a",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-21T04:47:34.4113486-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:47:34.4113486-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6973096c-c309-42b7-b514-76ad009e41b2",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "135bd0ac-6226-4fdf-9e52-03c62b117e18",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b7b5c689-38bd-4c91-aea7-5f29a6a62480",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-21T04:47:34.4113486-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "18a0d4d8-dd05-463a-91c3-8d863a9f8cf5",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-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": "b5d6f5b0-42fd-48c2-8599-55a8278e5890",
"Asset": {
"AssetId": "ad0937f7-92c2-4ebe-b045-c3e1bd10ec77",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "39aceaae-d0b2-4a6d-8284-f6fbb0afe5e4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "614dc0fc-32eb-4641-9791-6425be86c102",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1c0b4156-ad98-4c7f-b995-d2c86c1cdfcb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:47:34.4113486-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:47:34.4113486-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fa5a2e25-544a-4748-b761-9e9406981209",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-21T04:47:34.4113486-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:47:34.4113486-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3dcee195-e9ef-447e-bf74-4a056c9ae116",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "23f7df48-a43d-4745-b8ad-b652a61bc20e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8ab044db-334d-483c-ae67-9c1721ed6c54",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-21T04:47:34.4113486-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9a801c71-af15-4616-b40b-5a1571693b18",
"CreateDate": "2025-12-21T04:47:34.4113486-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:47:34.4113486-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}