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": "c466d0c2-172f-4017-aa82-f2e23d0ca959",
"Asset": {
"AssetId": "1ae3dd1f-3560-46ec-b1bb-e57ebf525e41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fdf2e9b7-eee5-4051-ac91-1917b5c3ac8b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3e1ffa90-7756-4477-8a40-0406d1438a24",
"CreateDate": "2026-10-04T14:37:51.4858294-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T14:37:51.4858294-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e3bf03aa-8cf5-4d07-8795-85df6d70bf2a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:37:51.4858294-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:37:51.4858294-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cf623d44-23d8-44e9-8503-34319ff090ad",
"CreateDate": "2026-10-04T14:37:51.4858294-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:37:51.4858294-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-04T14:37:51.4858294-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:37:51.4858294-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b9976109-0df3-4452-bfc3-59c99ca66a3d",
"CreateDate": "2026-10-04T14:37:51.4858294-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T14:37:51.4858294-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "47e53c6b-5ba9-49b5-aa95-6ec9e859f3d5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d3a69138-857c-44d7-8c8d-b9326112fae5",
"CreateDate": "2026-10-04T14:37:51.4858294-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-04T14:37:51.4858294-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-04T14:37:51.4858294-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cd274779-d31e-46aa-97dd-9c11f4268569",
"CreateDate": "2026-10-04T14:37:51.4858294-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-04T14:37:51.4858294-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": "3f80d02b-cbd2-4d03-869d-7688f5b67f4c",
"Asset": {
"AssetId": "0e0bda8b-bb6c-4e8a-a95b-2ebce0553e41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6efc58a6-60f5-4afe-b5ab-9ecfdb2c2e4c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "da45e71e-fded-4ddc-8f99-522ec109d6f9",
"CreateDate": "2026-10-04T14:37:51.5014558-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T14:37:51.5014558-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "97804776-c031-469d-a90e-cec996e3f94e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:37:51.5014558-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:37:51.5014558-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5414048a-0385-496a-861e-06ba0d5e20f0",
"CreateDate": "2026-10-04T14:37:51.5014558-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:37:51.5014558-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-04T14:37:51.5014558-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:37:51.5014558-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9d220b0a-dd99-4317-b1e4-de9486028efa",
"CreateDate": "2026-10-04T14:37:51.5014558-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T14:37:51.5014558-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d98e5c8e-9073-4c35-adad-6089bcd4f075",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "639744c7-eec2-4740-954e-1bb1e5530655",
"CreateDate": "2026-10-04T14:37:51.5014558-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-04T14:37:51.5014558-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-04T14:37:51.5014558-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "26ac969c-e501-407d-835a-18208101ad9b",
"CreateDate": "2026-10-04T14:37:51.5014558-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-04T14:37:51.5014558-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}