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": "2ba9d0ce-0b83-4336-b65c-5bbf441517cc",
"Asset": {
"AssetId": "02d4a5bd-ba31-4a5c-9f53-2bd88daa450b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "69a64a26-02a8-469c-a130-62625eae300c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3ee778b6-38ed-49d2-b48f-1bd19e5d8b11",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e1fcd86f-a22b-48e5-b723-060c0881d381",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-04T12:33:59.1373871-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:33:59.1373871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "242f4cfa-a310-42d3-a25f-2059a114584c",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-04T12:33:59.1373871-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:33:59.1373871-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "69076b5d-6d45-4ed6-ab66-4ec0c35d499a",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "57a61119-823b-4c18-8433-b43016356b20",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "43affdcc-912d-4d0f-b1a2-a5e818a5a778",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-04T12:33:59.1373871-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c4d6a017-e316-444d-9390-c125d641222b",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-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": "f0529685-4ee4-4c5a-a3f5-f890734f2c17",
"Asset": {
"AssetId": "5863c508-59d8-4c13-892b-4a22550f2f94",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e1319617-2a54-421c-9d28-17a83a473b4c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f16483c1-90fc-424d-887a-b2d113b835df",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "d5602301-0456-44a5-972f-df6b812a4d57",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-04T12:33:59.1373871-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:33:59.1373871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2319632a-9fee-435e-ae16-e4bcb88fd367",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-04T12:33:59.1373871-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:33:59.1373871-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a12e8a61-17b8-4d09-97b8-ec22e1e82070",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "29915d1f-2474-4454-9995-f3a0b8412e4f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6bf1f3eb-f3c9-4a49-8245-44d5ef210688",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-04T12:33:59.1373871-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "42cee272-cc06-46bf-9b29-1e6f20982c40",
"CreateDate": "2026-05-04T12:33:59.1373871-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:33:59.1373871-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}