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": "2dcd21d8-24d8-401a-ad01-0e73e3d6220d",
"Asset": {
"AssetId": "e08261b9-6e04-48e1-9146-e0dfc02aaeb8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "75c94b8e-880b-4219-bcb3-ed9a5fb7f745",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0037d1d6-cb3a-482f-8c53-27a124decff7",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4bdfbb9d-fa93-447a-8bfc-e5a4352b4359",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-15T02:19:17.3202437-08:00",
"MeasurementValueNeededDate": "2025-11-15T02:19:17.3202437-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e784d1a3-322b-4d30-bc05-4589d4724936",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-15T02:19:17.3202437-08:00",
"MeasurementValueNeededDate": "2025-11-15T02:19:17.3202437-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "899eb3c8-d139-4311-861c-eebaf9e83e83",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "99d94c6b-3c9a-4614-a84a-c199894475d9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "91ae2698-90a4-42f4-a6ed-27a4eb870d77",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-15T02:19:17.3202437-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "11df3df5-5898-4e91-8ad0-b47e90ddbe93",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-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": "30986880-a844-4d13-bda4-f6a72b9d1737",
"Asset": {
"AssetId": "2dbea88b-01d2-484d-beff-32317ce186f7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "cfa1102a-4175-4b58-8496-91a7b998320a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "afa6e16d-6a78-45c9-8d7d-9a40abdc1601",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8a251800-8356-4e16-9fdf-f489187afdbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-15T02:19:17.3202437-08:00",
"MeasurementValueNeededDate": "2025-11-15T02:19:17.3202437-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "232c140a-ad7c-4ae9-a4d1-a4f46f6cd010",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-15T02:19:17.3202437-08:00",
"MeasurementValueNeededDate": "2025-11-15T02:19:17.3202437-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "650a964e-2d2d-4f3b-a3d2-d762c8871789",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "608a13ff-2b1a-4551-8477-99c01979bdf9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "355167fd-7bbe-4591-8937-55e19125588f",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-15T02:19:17.3202437-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d8bdf35a-ac7f-4317-89c6-88c0c0035f70",
"CreateDate": "2025-11-15T02:19:17.3202437-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-15T02:19:17.3202437-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}