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": "08126048-7fbb-4b0a-a500-69fe2b448543",
"Asset": {
"AssetId": "028c57eb-526c-453b-94cc-c645368fbba8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9c24f648-ae3f-4578-acf8-6b5a1ca0335a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e9a99b62-d3c4-4631-9cfb-3eda7306a610",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b71ae3e6-07c0-4d92-928f-1604c5f7db2f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T19:05:00.0340354-08:00",
"MeasurementValueNeededDate": "2026-11-21T19:05:00.0340354-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "af67b8dc-fa5e-4442-9da1-df7e248130ef",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-21T19:05:00.0340354-08:00",
"MeasurementValueNeededDate": "2026-11-21T19:05:00.0340354-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0f1f644e-5022-4cba-913a-fda7f9379d71",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b03d553f-4739-4e33-91b0-bba647a910c7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9be4d255-ce58-4a53-b37f-69af6ca2d5e3",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T19:05:00.0340354-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c9a9bf72-5bd1-4c43-946a-8b37c3dc2734",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-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": "7e11de0a-f0e5-43f0-961e-f9b539099a56",
"Asset": {
"AssetId": "4103d6e6-0a97-4fcb-b907-06b77dd5e9ad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "288436cd-6009-4b1f-888f-c603090f6461",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7da3bb17-4c9c-4097-9014-24a45b02fce6",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9b6c3822-5cd9-4a33-9a16-c0bd0a640638",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T19:05:00.0340354-08:00",
"MeasurementValueNeededDate": "2026-11-21T19:05:00.0340354-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4f68de12-a396-46ca-afe1-dd478ed43b81",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-21T19:05:00.0340354-08:00",
"MeasurementValueNeededDate": "2026-11-21T19:05:00.0340354-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a86759ee-f732-48c8-8aa6-105edc791e7c",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "7ae4d7cc-39c7-4bba-acb2-95f27499c1ab",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "776ca342-37bc-4b37-be77-efe241bcb5bf",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T19:05:00.0340354-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d7c2c2bc-79f4-4192-a90a-ecd0531ffe4d",
"CreateDate": "2026-11-21T19:05:00.0340354-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T19:05:00.0340354-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}