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": "77ab22c0-f499-46d9-9d87-c64598c2710d",
"Asset": {
"AssetId": "a139a49d-4d02-463e-8f99-19c4ba92d1d1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f37a28b1-c069-45ec-97ee-c44976ddd0d9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2a220b4a-2d6a-4d0a-82f6-fbbda4dd4e4e",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "55760c4d-5314-4803-8c95-9f46274ed93c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-27T01:13:12.327211-07:00",
"MeasurementValueNeededDate": "2025-06-27T01:13:12.327211-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "99b81177-9e45-4099-b24d-e7348be93055",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-27T01:13:12.327211-07:00",
"MeasurementValueNeededDate": "2025-06-27T01:13:12.327211-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "50edd6b0-6fb7-4b27-acb2-3b16946c7266",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "9233cd8e-0cf1-4e3a-86b0-7039dea2a8cd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "81b7c35d-9a6a-495e-8873-648f2eaa8fd1",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-27T01:13:12.327211-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0d725730-4be8-448e-8fc5-d5a95f592e0a",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-27T01:13:12.327211-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": "d4264d35-21b4-4558-8bfc-c5d5070c6b4e",
"Asset": {
"AssetId": "e6ef9bb7-ebe2-41fc-8ae3-c0af59b32ee0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e59d5d18-2bf2-4517-a698-de11d28d7901",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f433e634-ab78-43ae-ba58-d4d7550efd96",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9bf32928-1f1c-457f-91f7-53b19320b9f1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-27T01:13:12.327211-07:00",
"MeasurementValueNeededDate": "2025-06-27T01:13:12.327211-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6b5e9fb3-ebb2-4eef-9183-4c166ec843eb",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-27T01:13:12.327211-07:00",
"MeasurementValueNeededDate": "2025-06-27T01:13:12.327211-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "45bb237c-9d50-44f8-a33f-ceeb75da535f",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b97c0085-bf4d-4c4d-b8dc-010a505acb98",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "91df21e3-5599-422f-8692-493a5574430a",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-27T01:13:12.327211-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2efeb90a-5e8e-4e1c-8c0a-ed23e2cf8d16",
"CreateDate": "2025-06-27T01:13:12.327211-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-27T01:13:12.327211-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}