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": "ca2911fa-37c6-47e6-9c3e-17fb8d87cdac",
"Asset": {
"AssetId": "a092ae85-3360-4316-afbc-b3b1fe4b2fe9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "eb5119c1-83ee-4187-ac23-84543328d38d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "67f10087-8aca-45ab-ac4f-13c9be14ef5d",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "be95597f-bb2b-4488-b42d-1f0afdb05223",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-30T13:52:28.5398012-07:00",
"MeasurementValueNeededDate": "2025-04-30T13:52:28.5398012-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9f18fdca-e716-4ff0-929d-9d895cf46d5d",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-30T13:52:28.5398012-07:00",
"MeasurementValueNeededDate": "2025-04-30T13:52:28.5398012-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dc973072-5db1-459e-b67b-beadec45c6e8",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "fee73711-43ea-4164-ae4f-9079468886e5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "363b5c5d-571b-4c90-ab22-5d338f95ca01",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-30T13:52:28.5398012-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d10a7d3f-096c-4e37-9b41-46ac1bbdd5a1",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-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": "62a4c78e-60b1-4610-b672-a0941b65a17b",
"Asset": {
"AssetId": "9dd17229-b3c9-4754-8ea4-93826b216ef2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2a646758-9af2-4e6e-98ee-e41dce60716c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b9b24ab3-d224-4c91-8855-fc5a1e92978a",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "844bda76-2afe-493d-81f3-ef68d7409704",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-30T13:52:28.5398012-07:00",
"MeasurementValueNeededDate": "2025-04-30T13:52:28.5398012-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "23d9a8a3-43d3-4ace-a285-0b869e6de933",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-30T13:52:28.5398012-07:00",
"MeasurementValueNeededDate": "2025-04-30T13:52:28.5398012-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d88a6544-f4c6-443b-a048-f53a423b297d",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "46e87ae2-dd9e-461a-a4c9-3d31cc4b02da",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1f9d50e1-5cd4-4c47-b658-272af6750c84",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-30T13:52:28.5398012-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d9e69e70-631b-42f2-bb7c-3d019a0d2f67",
"CreateDate": "2025-04-30T13:52:28.5398012-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T13:52:28.5398012-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}