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": "cf9b1ad5-c2f3-4caa-8762-6ffaf85c3e01",
"Asset": {
"AssetId": "50265bcc-e897-45ae-a573-1eb22421d921",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ee85394f-1dac-46a7-9833-73bd12e32639",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "860fe9ac-8098-4b00-9aad-e8fc9d285a2c",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "26bf99f0-1729-45aa-bda7-dde1d97b80d3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-01T15:11:39.4307822-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:11:39.4307822-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d465d151-235c-4b0e-9a5d-ee4beb3736ed",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-01T15:11:39.4307822-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:11:39.4307822-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "16a8b423-ef13-4ed5-95c7-830686e3a17e",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "61956051-1973-40bc-b5bb-d10a345a6abf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "519b90f8-cf30-4f5e-8a48-a61a5a324420",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-01T15:11:39.4307822-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ebe97272-7f8e-4e33-9d39-e15002fad4e2",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-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": "fcd66bda-b09a-4390-adf3-f205eff1ee70",
"Asset": {
"AssetId": "c0bd96dd-94cd-49b9-a7ae-025d612641b8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2479ef83-0bac-4963-b330-7530df7ab80f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d2cfb932-5fdc-443c-a887-eb80d9d806c8",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5fc457d9-46c9-43b1-8966-571053543ffd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-01T15:11:39.4307822-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:11:39.4307822-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a4b6b94e-3a4b-4ad4-b733-0bf8b7a54118",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-01T15:11:39.4307822-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:11:39.4307822-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d8b4d436-1d77-4c77-aa76-b5d216851410",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8bb932fb-a131-4561-99eb-ddb758a9d4c0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "44a4d108-0a32-488a-8edf-b6ef2de7391c",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-01T15:11:39.4307822-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1a3a9ae0-14ff-4200-a4df-6650e4a583f6",
"CreateDate": "2025-12-01T15:11:39.4307822-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:11:39.4307822-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}