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": "fc37e018-f58a-41c3-9a44-b51d75c5212f",
"Asset": {
"AssetId": "63574ddc-4d46-4fff-ab8f-e6fe2d6fc672",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "19ecc406-4289-4154-b0d1-76876ad608f6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "652f4431-0292-4c9a-9b49-e2bd8745b52a",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5565a47e-335c-46c9-9ed2-f122fcbcd88b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-13T23:54:10.7426583-07:00",
"MeasurementValueNeededDate": "2026-07-13T23:54:10.7426583-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3c49a888-873d-4e0b-9f46-80ea1669a35b",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-13T23:54:10.7426583-07:00",
"MeasurementValueNeededDate": "2026-07-13T23:54:10.7426583-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fce4f840-2d21-479b-b5e3-0fe0eda77460",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "df728749-5461-438c-be92-da952c25e609",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3fe248ff-a87d-4b47-a507-f5cbdb55f55b",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-13T23:54:10.7426583-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ef765725-f7e1-4fa8-8658-c7c02c231782",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-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": "6e89668e-8b0b-4096-9679-847dc5309040",
"Asset": {
"AssetId": "41a96870-ddab-4b32-be3e-34ed6554afc5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f1a18882-ee46-4244-ad22-d6a621a5f8a4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7e2e3f8d-08eb-445b-bb85-7ec775aa27c1",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e37359d9-1200-48cc-b368-3aa261274368",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-13T23:54:10.7426583-07:00",
"MeasurementValueNeededDate": "2026-07-13T23:54:10.7426583-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a2aac923-c168-4b2d-8b33-2f6fa85738ad",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-13T23:54:10.7426583-07:00",
"MeasurementValueNeededDate": "2026-07-13T23:54:10.7426583-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "45da3a3d-7417-434e-a251-fb186972f5d4",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "38c0b855-2bdb-434d-95c7-9f264d3469e9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0d39ce7f-168a-4716-a6c2-0bc79bf0482a",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-13T23:54:10.7426583-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1e3c08c8-b785-4ddf-a00d-beba5b9a9bda",
"CreateDate": "2026-07-13T23:54:10.7426583-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-13T23:54:10.7426583-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}