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": "ddb6e974-cb54-4899-8144-b855505bc46c",
"Asset": {
"AssetId": "60f5a86d-551b-471b-b9b9-916aa25f9315",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "27b40a2f-18a2-43d5-96fd-bc175fced916",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5acc299d-b883-4f7d-bafb-5039712ae813",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "63e142a0-2922-4784-83fe-e70852c5e365",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-19T02:29:58.1080275-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:29:58.1080275-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "33ce4fd8-1dcf-41c0-8bff-25a6bb55a542",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-19T02:29:58.1080275-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:29:58.1080275-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fddfea03-cbe9-4110-b492-e443ddd1e093",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a3fc8919-b500-4b4f-b35a-eba9121b20d7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a4328a77-5a7c-449f-abbf-fc703412c7d4",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-19T02:29:58.1080275-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0202171b-6b16-48eb-840b-513600953f22",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-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": "501da740-17a1-4103-b9be-85d4ff900e3c",
"Asset": {
"AssetId": "cb9fcb94-05d3-4954-a679-de09a7f9447f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "337b65d1-cd81-4268-9218-fcb96ebac8f6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8b398d99-7aff-44ba-b2cb-657ffb9defda",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1cfac603-8dbb-473b-8d9a-9340b161244a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-19T02:29:58.1080275-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:29:58.1080275-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3084a649-239e-4322-b1f6-d14bedf3de98",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-19T02:29:58.1080275-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:29:58.1080275-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af6da111-945a-4fa6-af75-ec01faea486d",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "599a3395-62a7-4718-81bb-e1f0649933bc",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6371baca-1126-42df-97f2-3e97cf652158",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-19T02:29:58.1080275-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a5d283ad-82f5-4fef-9130-bae0d726a006",
"CreateDate": "2026-10-19T02:29:58.1080275-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T02:29:58.1080275-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}