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": "798e76b6-7c9d-4482-9e6c-0a2b47dfba66",
"Asset": {
"AssetId": "1934ae73-f163-43f9-8638-5af0052a4dc3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "442e9e4e-fbdb-477c-a68e-07e09363c8f2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "df028687-2075-4e01-8363-3897bfe9ed70",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "684e8c8e-2ff6-40fd-ae04-da3d3a900c17",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-18T00:14:48.7164899-07:00",
"MeasurementValueNeededDate": "2025-09-18T00:14:48.7164899-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "439be5a8-3d15-409c-9d64-47b32e153846",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-18T00:14:48.7164899-07:00",
"MeasurementValueNeededDate": "2025-09-18T00:14:48.7164899-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a93a2ae7-5396-444d-9905-1b0b54fd6e27",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e8838402-b989-429a-ba14-3494f329aa73",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1577fca4-334a-43dd-b1a7-9ed803ddc5f8",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-18T00:14:48.7164899-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0565bcc3-973a-4101-baff-b491b663bada",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-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": "deec151f-e32d-4605-8218-d55b5337bfa4",
"Asset": {
"AssetId": "462fe093-6f07-422e-8e1e-8f34da873927",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3ee4d7aa-adb4-4716-af27-f5467839cced",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5076dae3-5d4c-46ff-8dd3-285bd3194852",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "782eb01d-290e-4ee5-84ac-d225a11a9cc1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-18T00:14:48.7164899-07:00",
"MeasurementValueNeededDate": "2025-09-18T00:14:48.7164899-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e7ea6a8f-6a95-43dd-ac32-3405bc54954f",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-18T00:14:48.7164899-07:00",
"MeasurementValueNeededDate": "2025-09-18T00:14:48.7164899-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d2afe091-db5e-4773-9050-b21baf6cfac1",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "97ad93e2-fe5c-44fa-b220-200f934ad638",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c5121f04-56ec-4b77-9f4b-351f6600764d",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-18T00:14:48.7164899-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b74d74e6-6c58-4446-b431-1a071363fb44",
"CreateDate": "2025-09-18T00:14:48.7164899-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-18T00:14:48.7164899-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}