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": "f5d239d5-9cca-4ded-bdca-ce0e21664eb0",
"Asset": {
"AssetId": "b0192d0c-df33-494f-8ef1-15bf99f2c3c6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4b5be4c9-e7d3-4801-8c6b-73ab982a7777",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1f744d0b-f615-45bc-91a8-a453bf1c758d",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8c19076c-aa9a-410d-aff5-d87636a73356",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T08:04:29.3467473-08:00",
"MeasurementValueNeededDate": "2025-02-05T08:04:29.3467473-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ea2a6b74-b977-4377-b7bf-8de27ac105ec",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T08:04:29.3467473-08:00",
"MeasurementValueNeededDate": "2025-02-05T08:04:29.3467473-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9dfd6bef-ad70-4ed5-aada-0d11e649b32a",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "710055ff-a5dd-4c84-b60a-2fbc084d956c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "30108c27-4529-4434-aebb-8d7a9ac163dd",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T08:04:29.3467473-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "301e2376-8e4e-4492-ac3a-2aac1657c726",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-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": "227b816b-9d0b-461a-9b0c-6549ddee1300",
"Asset": {
"AssetId": "789c7190-2fdb-4d2d-a981-2ca23f97e0e2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8973febd-d4db-4534-85ff-b6c66d0d43f2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "db37982c-ba70-430a-9a86-a42b94753407",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "250c3a32-36e3-4738-a1b6-17e1671c69e6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T08:04:29.3467473-08:00",
"MeasurementValueNeededDate": "2025-02-05T08:04:29.3467473-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fde73125-4a50-4acd-8f87-0d5b6c775517",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T08:04:29.3467473-08:00",
"MeasurementValueNeededDate": "2025-02-05T08:04:29.3467473-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0ac072d0-4e20-4dac-bfb2-19c73d6842b8",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8ac04da3-245d-4f58-a207-93b3b8d24f71",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "00ff9528-e80e-4c88-9cd2-6f3984ef5b30",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T08:04:29.3467473-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2866ee4f-a0d1-4c6b-96f5-215aa7ba834a",
"CreateDate": "2025-02-05T08:04:29.3467473-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T08:04:29.3467473-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}