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": "c03b0522-ea3d-441d-aed1-2183353660ab",
"Asset": {
"AssetId": "098dc384-9a6c-4d31-bcdb-ddeed4481839",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7c2f5d9c-b40b-441d-af7c-a4c2ae284e73",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2b24fdd8-a192-4d63-bf11-86e3110988ac",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "def513dc-3926-465a-84c0-2aee29f91a22",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T20:38:54.5023761-07:00",
"MeasurementValueNeededDate": "2025-06-30T20:38:54.5023761-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "23d580ce-01d1-4a2f-bfdd-60268020d434",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-30T20:38:54.5023761-07:00",
"MeasurementValueNeededDate": "2025-06-30T20:38:54.5023761-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ca20efac-2ac1-432d-860f-da256b3b8ef2",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "de589756-58c1-4bd7-bf5a-56fc9e107a07",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "73f044d1-21db-4c2c-9190-eb316f7c8cd7",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T20:38:54.5023761-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a2dfd523-2410-40c3-aba1-9301d1f3ed02",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-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": "bf11e1ad-b6cf-4ca0-9be8-15a7cd0263c6",
"Asset": {
"AssetId": "851f6b08-9dc2-4455-a2b6-583fff5a87b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "26c6d6a3-a4ab-4da5-bd7f-cf6e977b2fcf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "54b99a87-c7b7-401e-83b9-f01e21ffcd4e",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4e2a00bd-0d53-469a-85d9-aa6e6232c3e6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T20:38:54.5023761-07:00",
"MeasurementValueNeededDate": "2025-06-30T20:38:54.5023761-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9ff2c9aa-d225-4b14-a29b-c33204840350",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-30T20:38:54.5023761-07:00",
"MeasurementValueNeededDate": "2025-06-30T20:38:54.5023761-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "39a42b6a-9dfa-4a8e-8b8b-acd958e50bb5",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "85bb4078-d022-4580-abce-c8d4232ecb8a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "20515733-dfa0-4366-977e-a8e1776c2f52",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T20:38:54.5023761-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "42a25dbe-c6b6-45ac-8194-0ba9f65b0d26",
"CreateDate": "2025-06-30T20:38:54.5023761-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T20:38:54.5023761-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}