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": "956011cd-4d75-4613-b524-70758ea26edd",
"Asset": {
"AssetId": "a5ec45a0-f78c-4124-998b-0ca22cd303e2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7b4f0239-2fab-412d-95a1-fa452a136b87",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4eb51c5c-0570-4b95-93fb-18cee2c7f4c2",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5ce3fcb4-7dcf-4966-a9f8-f1869de32097",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-16T00:40:26.2103967-07:00",
"MeasurementValueNeededDate": "2026-03-16T00:40:26.2103967-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1650f3e7-f691-4743-942c-4452f7344b21",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-16T00:40:26.2103967-07:00",
"MeasurementValueNeededDate": "2026-03-16T00:40:26.2103967-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1eedbf7d-7cae-44fd-bce3-7dfed66b27e3",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "09d0edba-d2bd-40ea-9f3b-281d216e2649",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4c261c50-3539-4ab8-bfbe-c435aa3dcf1d",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-16T00:40:26.2103967-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "124ccb52-51a5-422c-9fa2-a6201f573c41",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-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": "9459841f-8a02-4ab0-b67d-b19334e6ec38",
"Asset": {
"AssetId": "fade9c0b-67cf-4793-9dfa-fdf733d9cbb5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0d582001-768c-4724-95b8-08b9c3515d59",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b5c5bceb-feb2-40be-83ef-18561bf17a73",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4adf06f7-d2d9-4278-a951-f3cbaab85daa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-16T00:40:26.2103967-07:00",
"MeasurementValueNeededDate": "2026-03-16T00:40:26.2103967-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "92989f45-982a-463b-a4b9-f06d2f2dfc64",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-16T00:40:26.2103967-07:00",
"MeasurementValueNeededDate": "2026-03-16T00:40:26.2103967-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0fb827b6-0d3e-455f-9c34-327a6948e21d",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f1359126-3fea-406a-bcf5-76c9e55034b0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "be82bbd7-5ec2-4f33-9b2d-90ae55f6adba",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-16T00:40:26.2103967-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b03e7ad8-373e-48e4-a44b-55d98abfb3f7",
"CreateDate": "2026-03-16T00:40:26.2103967-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-16T00:40:26.2103967-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}