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": "e93fe700-aed8-4543-b19a-45208692246c",
"Asset": {
"AssetId": "ce02d1b3-e06f-4f66-a286-0099f90a1498",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fc920a76-8c09-4396-bdaf-270ed17c6216",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f45df96b-72de-42d1-bd00-379f72c494bc",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8d11bace-47bd-44af-b900-5500f39113e3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T02:36:05.8575575-08:00",
"MeasurementValueNeededDate": "2026-03-04T02:36:05.8575575-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8f1b55b3-ca76-4402-b60a-bd170a5ccf52",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-04T02:36:05.8575575-08:00",
"MeasurementValueNeededDate": "2026-03-04T02:36:05.8575575-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0bdce839-d157-4ec8-b254-02d140da9407",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "68de3df7-9693-487a-8b30-bc4e2ec9ea80",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "946db135-403c-4ace-a64b-32a3c3b870e6",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-04T02:36:05.8575575-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "067a437a-2cb7-45ac-8f09-4aea4393e8c9",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08: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": "a20d4a9d-68e5-4099-9750-ce41bcd493c0",
"Asset": {
"AssetId": "1f29992e-e150-4ccb-aea2-b482f7916285",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b96fba39-0cae-43aa-b062-b83c00c05e6b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c17075ca-35af-4cb7-86aa-827f13ebca34",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "963ff611-1383-4ea7-b62f-977356977f11",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T02:36:05.8575575-08:00",
"MeasurementValueNeededDate": "2026-03-04T02:36:05.8575575-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f15b919a-0432-4b9c-811f-1092df252964",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-04T02:36:05.8575575-08:00",
"MeasurementValueNeededDate": "2026-03-04T02:36:05.8575575-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "82e10405-af63-475f-96ff-a92d64c20e24",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b73b24b3-5a92-44a5-9220-cee931fc67c8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1a266636-202a-4b9b-9005-a9b4dadd2941",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-04T02:36:05.8575575-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "442a724c-c665-431c-b01d-cea8a3433bce",
"CreateDate": "2026-03-04T02:36:05.8575575-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-04T02:36:05.8575575-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}