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": "b244c0fa-f1e1-4e3c-bdb7-8759f2139f22",
"Asset": {
"AssetId": "553a3667-cd3a-4af9-b34d-9ce2a5effc2f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c6794568-3f99-466a-aac4-3f9960359163",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9aec10be-2449-45aa-9933-9ca2de0aa2e2",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6befc335-49e4-4788-aab7-b1472bcb24a3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-30T16:46:08.8478031-07:00",
"MeasurementValueNeededDate": "2026-04-30T16:46:08.8478031-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b4387dad-84b4-4689-aac6-eec638aea3d0",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-30T16:46:08.8478031-07:00",
"MeasurementValueNeededDate": "2026-04-30T16:46:08.8478031-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "013bd73a-7da0-4084-b50b-432737d64b11",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "56ba64e3-7b19-45ec-8145-2af61f33e3cf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "171ff804-2a2c-4fbf-8db1-6e4e85820723",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-30T16:46:08.8478031-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c9d7acc2-5547-44c0-80ac-5c01bdb13a68",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-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": "7089445f-779c-4987-abde-917b03abb1f4",
"Asset": {
"AssetId": "c8b3ee2f-b7df-4c68-ace4-961977950e19",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "01ee9dee-d726-4b9a-9583-5c399a8fe806",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8b948de2-0f12-4f6c-96ba-98e82d01776d",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e8f31997-5fb3-4e5d-bf70-9404cfbb35f6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-30T16:46:08.8478031-07:00",
"MeasurementValueNeededDate": "2026-04-30T16:46:08.8478031-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "916b4012-2c29-4584-9219-304f5307e0ee",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-30T16:46:08.8478031-07:00",
"MeasurementValueNeededDate": "2026-04-30T16:46:08.8478031-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "41e61c74-dc72-4a5a-accb-daf18634319b",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "c3589c34-5aed-4537-bb4c-2863931e1301",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "76d7df14-427d-4d68-ac73-246d53d8c617",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-30T16:46:08.8478031-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "360d0adb-2565-49ac-a182-9b2ff245b15d",
"CreateDate": "2026-04-30T16:46:08.8478031-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T16:46:08.8478031-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}