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": "d452a62d-063f-4830-8b03-6313c2560010",
"Asset": {
"AssetId": "f5c90565-144b-43d2-a2dc-e6362e27c715",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "10d3d928-4164-47ce-9943-0c4c40c9a682",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "416333aa-8861-4bab-89aa-180e23d8ee91",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9c504b78-2d93-4dd1-8d43-185a9ad4dadf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-08T20:06:34.5205843-07:00",
"MeasurementValueNeededDate": "2025-05-08T20:06:34.5205843-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "db544168-e105-4ea7-95ef-26f15c4149af",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-05-08T20:06:34.5205843-07:00",
"MeasurementValueNeededDate": "2025-05-08T20:06:34.5205843-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1da45921-ccf0-4814-9670-6e5b2489bfd0",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "43a9f1fa-96b0-4495-a282-1aeac65bfa20",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ef3103c4-65b3-4015-af54-e44555f28ff5",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-08T20:06:34.5205843-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "02e04f93-52c1-43f8-9cc7-2540cae071d3",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-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": "1c7cc7fe-db65-4b89-9013-e113471cda22",
"Asset": {
"AssetId": "54dff76a-c6ef-4158-8725-ef87b8a404ee",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "693a164e-7b0f-4e4f-8127-c57ee6c02694",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "55460292-8c56-4ca9-861d-4edb552b22ce",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6e9254fb-6999-4598-b90d-60683c2a66c4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-08T20:06:34.5205843-07:00",
"MeasurementValueNeededDate": "2025-05-08T20:06:34.5205843-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fc32d1e9-39c8-480c-a055-e106ec1d945e",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-05-08T20:06:34.5205843-07:00",
"MeasurementValueNeededDate": "2025-05-08T20:06:34.5205843-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "455a7f2e-febb-4f0f-870d-1759e9dfe83a",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "dea90dc0-61f2-4913-8f1c-4da21177026b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fd31d80f-efcb-4ac6-937c-e101c574c841",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-08T20:06:34.5205843-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "eb632414-3227-499b-bc5f-7a2b60b9ac59",
"CreateDate": "2025-05-08T20:06:34.5205843-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T20:06:34.5205843-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}