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": "04d9033b-2791-44a8-a5a8-c8cb82421fe4",
"Asset": {
"AssetId": "da94f5df-95a9-408e-9f05-4303940cbfac",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f797ece5-15dd-4326-a246-a4bebd2a6da7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a4a06ebb-2b68-4c0b-8f6e-4ab2e60e6e42",
"CreateDate": "2025-08-08T12:34:36.1649106-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-08T12:34:36.1649106-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f4dc4893-0e32-47b2-aa48-6dbeb0b25266",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-08T12:34:36.1649106-07:00",
"MeasurementValueNeededDate": "2025-08-08T12:34:36.1649106-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "84997b27-5c1e-4bbe-93c3-db1e8c1cffd2",
"CreateDate": "2025-08-08T12:34:36.1649106-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-08T12:34:36.1649106-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-08T12:34:36.1649106-07:00",
"MeasurementValueNeededDate": "2025-08-08T12:34:36.1649106-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f96e9c2c-a139-496e-95d6-43b859425324",
"CreateDate": "2025-08-08T12:34:36.1649106-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-08T12:34:36.1649106-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "bd16ba1c-149d-4b36-b973-8b094058763c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e3147d52-9494-4244-99e5-222ec6389114",
"CreateDate": "2025-08-08T12:34:36.1649106-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-08T12:34:36.1649106-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-08T12:34:36.1649106-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c18fd83c-0bf6-4f39-9a95-80e5b7902221",
"CreateDate": "2025-08-08T12:34:36.1649106-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-08T12:34:36.1649106-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": "9b4ec4b3-25b8-488d-9a96-656440f82b7c",
"Asset": {
"AssetId": "785f8984-f781-40d6-b816-c9a250326e77",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "20bfdfe5-f2bc-483f-8391-9cb903ab598b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2460603c-4349-4af5-94ff-1570c32b5d58",
"CreateDate": "2025-08-08T12:34:36.1804735-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-08T12:34:36.1804735-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bba06970-b85b-495d-ab85-20f85039dd6c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-08T12:34:36.1804735-07:00",
"MeasurementValueNeededDate": "2025-08-08T12:34:36.1804735-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4d1f6006-4f06-4494-96a7-5d7cc1313ebf",
"CreateDate": "2025-08-08T12:34:36.1804735-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-08T12:34:36.1804735-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-08T12:34:36.1804735-07:00",
"MeasurementValueNeededDate": "2025-08-08T12:34:36.1804735-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "db698446-55f3-4630-8a4e-0b2af7f0a9e5",
"CreateDate": "2025-08-08T12:34:36.1804735-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-08T12:34:36.1804735-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "10ec07a4-abde-48c7-ac63-6054afff44d5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4717f73f-9751-4319-94f1-d3dfce7df915",
"CreateDate": "2025-08-08T12:34:36.1804735-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-08T12:34:36.1804735-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-08T12:34:36.1804735-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "15a26aab-33f8-4de7-8a08-85423114ace8",
"CreateDate": "2025-08-08T12:34:36.1804735-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-08T12:34:36.1804735-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}