POST Notes
Creates a new note.
Request Information
URI Parameters
None.
Body Parameters
The note to create. NoteId should not be filled in.
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": "f451de7d-60ea-48c2-b880-1ed2a47df479",
"Asset": {
"AssetId": "2844361b-7c4f-4af5-b009-c4e333c8c16a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "02f38b11-be3d-4790-8286-37e57e9dd78e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "06243e80-ec7c-4053-9f12-082ecc3e8bd0",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "033bfa73-929e-45ba-8002-8cd90593d120",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-14T09:17:33.7470536-07:00",
"MeasurementValueNeededDate": "2026-04-14T09:17:33.7470536-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "541a61a3-34a9-4442-a0b1-bd62a2ec8c4c",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-14T09:17:33.7470536-07:00",
"MeasurementValueNeededDate": "2026-04-14T09:17:33.7470536-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1defb34d-4ec7-4db7-9710-71b73a72dc17",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "bb466c17-a03c-4fc0-9468-8fba0ee3226e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "915c12ce-2235-41ed-9869-7ae21b656cd6",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-14T09:17:33.7470536-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c04d3eab-eed4-4570-a52b-3ee00409361c",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 5"
}
Response Information
Resource Description
On success, the created note.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"NoteId": "675dfcfe-88ae-4438-b9ea-9d0213000459",
"Asset": {
"AssetId": "dcdc2961-76d3-4629-9a1c-db0765d66c8a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c410d07a-aadf-4cda-9437-e553a45f15eb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "920e6244-63dd-47d5-9d21-93b859966cc5",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "586b89b9-98f7-4169-a0df-9d9a51ec8f86",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-14T09:17:33.7470536-07:00",
"MeasurementValueNeededDate": "2026-04-14T09:17:33.7470536-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8642e2ef-f90e-421e-8d4a-58e6c5103615",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-14T09:17:33.7470536-07:00",
"MeasurementValueNeededDate": "2026-04-14T09:17:33.7470536-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1444e6a4-b5b2-4325-bde6-032561dfc3a5",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "eee029d6-00a6-4c89-a961-09fbc5bd346e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5f5c64d-9508-4fae-b56e-512db5a52c37",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-14T09:17:33.7470536-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "605282ef-2ff7-4814-9e88-c4663704c2c6",
"CreateDate": "2026-04-14T09:17:33.7470536-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-14T09:17:33.7470536-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}