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": "7c12773c-1b48-49fc-b34c-134edc9fc091",
"Asset": {
"AssetId": "17aab46c-1886-4678-a45e-073fe5b51b92",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9f77e95a-e74e-4573-8aee-bfd79b780b3c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7d4c82f0-d253-4eec-b337-dde88b76c0c2",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0daa8f07-82fa-48df-a913-6cd88b6d6863",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-09T00:25:25.893104-07:00",
"MeasurementValueNeededDate": "2025-05-09T00:25:25.893104-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2937c2f3-bb39-47dc-aa8f-5c86e9a15950",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-05-09T00:25:25.893104-07:00",
"MeasurementValueNeededDate": "2025-05-09T00:25:25.893104-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fd58a0e4-7816-4cf2-b9e8-c4b6f5b7debe",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a5c7b462-4a0d-4355-a551-c74a97b9445f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ff322709-b224-4f8b-8720-c4184c17a62a",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-09T00:25:25.893104-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bea5bc2a-cbf8-4dc7-bd69-6b47af6d79c0",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-09T00:25:25.893104-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": "171172fb-5f48-4ed0-93ab-40317676007c",
"Asset": {
"AssetId": "f3c954a7-178d-4cb5-bfb2-3571ffa72b08",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0da566fa-00a1-47d7-80a7-52b2ef6b7cc2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a1ba51c2-0034-4091-92df-2012102734be",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fb571c71-eb4f-4189-b137-018a3befeb05",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-09T00:25:25.893104-07:00",
"MeasurementValueNeededDate": "2025-05-09T00:25:25.893104-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1bb9d344-a99f-4a8e-8246-4e73d5559509",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-05-09T00:25:25.893104-07:00",
"MeasurementValueNeededDate": "2025-05-09T00:25:25.893104-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a7a7c281-64b1-4d42-ab55-20acd1353636",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e1de9915-2665-4afd-b289-307ec7cb45cb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f0acfff8-a045-4105-af2e-6980ed070f7c",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-09T00:25:25.893104-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3f477878-f865-4292-9415-2595169ab45f",
"CreateDate": "2025-05-09T00:25:25.893104-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-09T00:25:25.893104-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}