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": "2457f95c-3746-4ab4-8ba7-157e8a3ccd2c",
"Asset": {
"AssetId": "b9842a35-484f-4f45-876a-0a35705d4aaa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "451a3b40-089b-4785-96c5-8bef8a0503e2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "21c65c21-d506-4ecf-9cfd-f356afd991e5",
"CreateDate": "2026-10-30T16:58:30.6722217-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-30T16:58:30.6722217-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "38eaa8e7-24f6-4774-b5a0-2711977998b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-30T16:58:30.6722217-07:00",
"MeasurementValueNeededDate": "2026-10-30T16:58:30.6722217-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "adf49446-b005-4b6a-9a2c-2853c7354227",
"CreateDate": "2026-10-30T16:58:30.6722217-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-30T16:58:30.6722217-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-30T16:58:30.6722217-07:00",
"MeasurementValueNeededDate": "2026-10-30T16:58:30.6722217-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4246eee5-9366-4bd1-a485-f3994f2c0905",
"CreateDate": "2026-10-30T16:58:30.6722217-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-30T16:58:30.6722217-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "12842dfd-9e6b-418a-909e-a10fe0e99ead",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e4379f06-0997-41ca-8ea5-b206ae90c1a8",
"CreateDate": "2026-10-30T16:58:30.6722217-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-30T16:58:30.6722217-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-30T16:58:30.6722217-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8d3a6e27-192b-450d-bc9f-6914316902e3",
"CreateDate": "2026-10-30T16:58:30.6722217-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-30T16:58:30.6722217-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": "1c165f05-6922-4807-a36c-b39fcef19746",
"Asset": {
"AssetId": "cb0018fe-bcaa-4437-ab4c-006165a94d20",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "cb04513d-59ca-4fa2-b96d-28d7537a23e6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d1435889-e432-4f66-9c65-088d9856ba7a",
"CreateDate": "2026-10-30T16:58:30.6878369-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-30T16:58:30.6878369-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "77029531-37e6-4189-870a-d637028f8501",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-30T16:58:30.6878369-07:00",
"MeasurementValueNeededDate": "2026-10-30T16:58:30.6878369-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8eed68b9-06cc-4cd0-aad3-02caae10f97a",
"CreateDate": "2026-10-30T16:58:30.6878369-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-30T16:58:30.6878369-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-30T16:58:30.6878369-07:00",
"MeasurementValueNeededDate": "2026-10-30T16:58:30.6878369-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "49e4f42b-e87d-4d4d-ac2d-8cf021314ff7",
"CreateDate": "2026-10-30T16:58:30.6878369-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-30T16:58:30.6878369-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "562ad8a6-fb25-4a43-bfad-ec61bdfc96dd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d74257c3-8193-46ca-b876-655857ccc2ed",
"CreateDate": "2026-10-30T16:58:30.6878369-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-30T16:58:30.6878369-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-30T16:58:30.6878369-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0748f923-c6aa-473c-8c01-4f8382bf360e",
"CreateDate": "2026-10-30T16:58:30.6878369-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-30T16:58:30.6878369-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}