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": "a3ce61a7-122e-4860-83d9-ace7f678af05",
"Asset": {
"AssetId": "16e2c12d-1528-48ab-92a6-94fa9ee781b8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bc02053d-322d-4363-9529-624d6b7689ce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "85ef0cd3-32e5-4055-9f88-9e3b2481ebf9",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "63e8cc0b-159c-4929-b713-6b7cbfe72fb0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-05T08:31:04.7351836-08:00",
"MeasurementValueNeededDate": "2025-11-05T08:31:04.7351836-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dcc85290-0c2c-4827-8b5f-cfc9861f524f",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-05T08:31:04.7351836-08:00",
"MeasurementValueNeededDate": "2025-11-05T08:31:04.7351836-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b009547b-e038-4a9b-8f01-128422fab19f",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "510b55a1-023d-4ca1-ad5f-f2fac699d955",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0bb3cc6e-77a7-463e-89f5-101325687f92",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-05T08:31:04.7351836-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a502be70-ee0a-41b1-bff5-03751dc7bd86",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-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": "5fcdadec-f471-4713-b38b-072ebd1b398d",
"Asset": {
"AssetId": "8ace89c7-40d0-423d-978e-4849a97ec714",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b4b14fff-6777-449a-bcc1-61dcaeb0dd3f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e7aff260-eba4-4d0f-82b5-3806e74ab1e2",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7a8a3d79-05c3-4fcd-b9ca-63a0d4f82707",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-05T08:31:04.7351836-08:00",
"MeasurementValueNeededDate": "2025-11-05T08:31:04.7351836-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "90077b6d-a33d-409c-9eb5-7fe93d936456",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-05T08:31:04.7351836-08:00",
"MeasurementValueNeededDate": "2025-11-05T08:31:04.7351836-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "470c0804-d6db-41f2-9835-ad7a03991075",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "958781c6-355b-42da-9a0b-25c67fc70efd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b8400689-c248-4da2-9451-eef7530d1e51",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-05T08:31:04.7351836-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7f63bc43-db72-42da-97f2-4cae4c84e84a",
"CreateDate": "2025-11-05T08:31:04.7351836-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T08:31:04.7351836-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}