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": "4de6d6e7-a297-42b3-9cfe-327c7a6ff5cd",
"Asset": {
"AssetId": "dbbb20f9-4691-4dd8-b396-a101d405cf79",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "77dc077f-13ba-4300-9709-9d56863d15e8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ef83f907-bb8b-4bce-854f-73b43599b2c2",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "2292d033-b425-4e84-b391-1c4c24f0f77d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T07:57:09.2949019-07:00",
"MeasurementValueNeededDate": "2026-03-24T07:57:09.2949019-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "de01df9f-ee48-418e-ad2d-6ee0a6f11d60",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-24T07:57:09.2949019-07:00",
"MeasurementValueNeededDate": "2026-03-24T07:57:09.2949019-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d1d94c2a-24f8-418f-999f-e8ac5e725fa0",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "6feb317c-e41e-4cc4-b516-1aadfde7d52e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c7df6cae-4053-4104-86dc-57067e61ff61",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-24T07:57:09.2949019-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ba28bb17-b259-416b-b26a-31c653f74961",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-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": "16578ddf-e849-4389-9796-e448aec5e37b",
"Asset": {
"AssetId": "e985bb0e-c673-48dd-aa57-35014b4d636f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1b164c55-c714-4892-94f2-e4ed558c3edb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2ca242d0-d43a-4b2b-9aca-c12d323df13c",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3fdbb346-d858-438a-957a-c0dacea5b57e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T07:57:09.2949019-07:00",
"MeasurementValueNeededDate": "2026-03-24T07:57:09.2949019-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bd3ee3fc-8e12-484e-bc3f-257e651d5b04",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-24T07:57:09.2949019-07:00",
"MeasurementValueNeededDate": "2026-03-24T07:57:09.2949019-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "16a6e0f1-5379-42cd-898a-1bd98b2bdb22",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b9bb1e30-6d35-4c17-a1f2-1a050eb2aaa8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fb6624b6-297c-4871-85a8-12d863b7b0f0",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-24T07:57:09.2949019-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e8458f2f-fd36-49cf-9fd1-bca7f24ad368",
"CreateDate": "2026-03-24T07:57:09.2949019-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T07:57:09.2949019-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}