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": "e8eadae4-a15b-40e4-a77c-d3668c13a40f",
"Asset": {
"AssetId": "e3767419-5c98-414a-b8fa-e1a8410f2a2c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bc797f52-f349-45c2-b438-1ec5f55acdf2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3825c511-adc6-4927-9964-edfdc451ab9d",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ffd70441-fca0-4cd5-ba47-18fa34b45766",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T13:08:17.163105-07:00",
"MeasurementValueNeededDate": "2026-03-13T13:08:17.163105-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a2d8409d-c2d0-4869-be3b-aabe42991d90",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-13T13:08:17.163105-07:00",
"MeasurementValueNeededDate": "2026-03-13T13:08:17.163105-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ebcbaf97-431f-4243-885d-39ce4fa02654",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "61df5cad-e266-4f9b-8131-3c3206f54cef",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d97fa3b8-6274-47b0-b664-26dbc5c02b93",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-13T13:08:17.163105-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "59f55062-4227-445d-b28d-b5127fc48fbc",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T13:08:17.163105-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": "b625de96-5305-45c2-bdd4-84c5fb326203",
"Asset": {
"AssetId": "5ca22764-cad2-478a-8931-61940e9bd434",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "91d09b1c-472e-4be8-a122-870d1d63a2dc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "402c6f6d-4961-4c4e-bac0-cc8bee99a3ab",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "85d6157a-05d6-42e1-8c23-dc73e57d8c9b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T13:08:17.163105-07:00",
"MeasurementValueNeededDate": "2026-03-13T13:08:17.163105-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "29b3608a-76a0-4f64-be79-2ed942bf493e",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-13T13:08:17.163105-07:00",
"MeasurementValueNeededDate": "2026-03-13T13:08:17.163105-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "443f4492-c507-4cd1-8764-cc59e39329ab",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "10157034-50fa-4a37-ae17-9486de14d8a7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2aa4c2f5-bc56-44db-920e-784bb18f9b52",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-13T13:08:17.163105-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "200ad4cd-04a5-422e-8d09-97ec33577336",
"CreateDate": "2026-03-13T13:08:17.163105-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T13:08:17.163105-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}