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": "46dbdbc9-c8f7-4e48-970c-bc2e04965a33",
"Asset": {
"AssetId": "ac85cba3-8841-4837-9440-4505889edf50",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6aaf0c99-c47a-4ca9-bc4b-eba9700e110e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0bd6284b-880a-4412-8ea5-1d7b80e52987",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e4f293d6-d891-4e2b-a1bc-1b6dd604b48e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T03:29:33.3643207-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:29:33.3643207-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "85005fa2-68bc-49aa-a297-cca2fd8d92a7",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-22T03:29:33.3643207-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:29:33.3643207-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2c31bc4c-fbf6-45cf-9fdc-553685e99ffd",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "53fd99d2-9241-4427-acba-ff99ecde7909",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0ed53278-92f5-4be2-a972-de686b68655f",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-22T03:29:33.3643207-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "089d6ad5-fef6-403b-9619-072bf4004ecc",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-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": "edc8b7da-77e5-4e21-aa8e-ced533ef5602",
"Asset": {
"AssetId": "b55b8f72-bacd-4990-946f-881da39bbd73",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "367020e0-389d-46d8-bf90-95a7aec87642",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e7dce30f-a957-478e-a60f-fa2aa5bf24c8",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "021c049e-5712-40a1-941e-76ebfa23e593",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T03:29:33.3643207-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:29:33.3643207-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d778ee42-1859-4322-a370-7f58427df1bf",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-22T03:29:33.3643207-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:29:33.3643207-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "29661fae-74dd-4105-9c16-e253179e9cd1",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1d92da55-e625-4804-964b-9bbc12314846",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d05eb170-2782-4353-aeff-6e93492e12cc",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-22T03:29:33.3643207-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1e38ee7f-4d93-4feb-bdf1-514c811e28c7",
"CreateDate": "2026-09-22T03:29:33.3643207-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:29:33.3643207-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}