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": "6624af15-410e-47b5-bc5e-cf1a2b1e18a3",
"Asset": {
"AssetId": "f110600a-79b9-43f3-bda7-75948756502d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c0e0da3c-0ded-4c3d-b1fa-12dc911f1845",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "33b6e65b-a622-46b5-b4e8-9e44f82182e7",
"CreateDate": "2026-02-12T01:16:06.5634-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:16:06.5634-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "da65a970-372b-40ea-a87a-b3224ccf61d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-12T01:16:06.5634-08:00",
"MeasurementValueNeededDate": "2026-02-12T01:16:06.5634-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "82c0a70a-8abc-4930-a6f8-03dbb9cf7bf0",
"CreateDate": "2026-02-12T01:16:06.5634-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-12T01:16:06.5634-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-12T01:16:06.5634-08:00",
"MeasurementValueNeededDate": "2026-02-12T01:16:06.5634-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "48afd9e1-53d2-4b45-a839-db65f8b5a60c",
"CreateDate": "2026-02-12T01:16:06.5634-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-12T01:16:06.5634-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "69da0fd3-8c6d-404f-bb73-e96b7438d6a3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "82d5c2ee-3599-41e6-8fc9-2b461fd8f4b1",
"CreateDate": "2026-02-12T01:16:06.5634-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-12T01:16:06.5634-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-12T01:16:06.5634-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "66e912f7-0265-42bc-8d3c-b15d7ed6f14d",
"CreateDate": "2026-02-12T01:16:06.5634-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-12T01:16:06.5634-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": "ff1d90b2-13c8-4eec-9c44-921333ce496b",
"Asset": {
"AssetId": "f8df7fca-7751-450d-aeda-cc178b6451d3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8e6bec48-7882-4b99-a951-2c838ab65a3d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dff8a033-e9ce-46a1-a5fe-6d1da095f8ea",
"CreateDate": "2026-02-12T01:16:06.5790931-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:16:06.5790931-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fc57eade-00c6-4f78-a744-6ae565703ec7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-12T01:16:06.5790931-08:00",
"MeasurementValueNeededDate": "2026-02-12T01:16:06.5790931-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a7b04fc6-5085-4c29-9d89-6b7cc61082f2",
"CreateDate": "2026-02-12T01:16:06.5790931-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-12T01:16:06.5790931-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-12T01:16:06.5790931-08:00",
"MeasurementValueNeededDate": "2026-02-12T01:16:06.5790931-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1515737a-99d3-4eac-93d1-3aa20acd1c48",
"CreateDate": "2026-02-12T01:16:06.5790931-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-12T01:16:06.5790931-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3cb805fa-8a15-4cdd-bceb-2079b70b0eb3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "81bbce76-3b3e-4584-a04a-f0faba875fc6",
"CreateDate": "2026-02-12T01:16:06.5790931-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-12T01:16:06.5790931-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-12T01:16:06.5790931-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "eb5818af-d8c8-46d3-a34b-7b82d3598f3b",
"CreateDate": "2026-02-12T01:16:06.5790931-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-12T01:16:06.5790931-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}