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": "150def6d-2ee6-4bef-b362-b911433d66e5",
"Asset": {
"AssetId": "3d99558a-5c96-409e-8ca7-3552153f6e76",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b51f40ce-c8c9-47c0-93aa-f744efcd5609",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8040f7c9-99df-44e1-adbe-480469862360",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5bde61ec-e5fe-411f-81c5-33f2014e2378",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T13:55:56.0026746-07:00",
"MeasurementValueNeededDate": "2025-06-16T13:55:56.0026746-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c1531ba0-ca82-4071-9a3d-01f78b1c40ab",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-16T13:55:56.0026746-07:00",
"MeasurementValueNeededDate": "2025-06-16T13:55:56.0026746-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "446cb5d4-99c0-43aa-8ab4-62ac38f3869b",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2fde74e5-e770-4b66-8b29-7ebb026ec1f7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9211476d-1829-42b8-a155-e1b2cd63da0b",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-16T13:55:56.0026746-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "33d2ba5a-6c50-4964-90e3-6031029e0484",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-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": "8a50bfa3-e602-4751-bdf8-60ea13c04097",
"Asset": {
"AssetId": "a6ec353b-7219-4a49-8b07-ca853b32601f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bcae1675-0ae5-4184-a46a-58738d77400e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "666679fb-24b1-4e90-b72a-dad9309dafdb",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f2be26e4-a866-40dd-8579-14c6d31464bd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T13:55:56.0026746-07:00",
"MeasurementValueNeededDate": "2025-06-16T13:55:56.0026746-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae89aedb-11be-4033-a5f2-92889465d342",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-16T13:55:56.0026746-07:00",
"MeasurementValueNeededDate": "2025-06-16T13:55:56.0026746-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d474e596-9c45-4d87-a1b1-a44c6e25ff39",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "22478c39-0bfb-45cc-a7b6-6b907186b6b3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "749fbde1-8d49-4b35-91eb-dc62f8e4dc6f",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-16T13:55:56.0026746-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8cc03f52-5378-46b0-ba6f-17597ea251ee",
"CreateDate": "2025-06-16T13:55:56.0026746-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-16T13:55:56.0026746-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}