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": "d0657ff7-a1ca-4777-b16e-12928e4b126b",
"Asset": {
"AssetId": "ba992757-78bc-435a-bad9-26bb4720589f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "070da9a3-ac4e-401f-b729-7f00302402ee",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f2566582-aaef-45f0-b354-47be87f20b0e",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "810062e2-45c6-4e03-886d-06d6c8c705da",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-16T15:41:24.9738187-08:00",
"MeasurementValueNeededDate": "2026-01-16T15:41:24.9738187-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "362c1603-d195-4d6e-982f-a2250911f13d",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-16T15:41:24.9738187-08:00",
"MeasurementValueNeededDate": "2026-01-16T15:41:24.9738187-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bf04429a-a20a-4dbe-9c80-feda0774ad4b",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b075613d-d5b7-44c7-89b0-312362d738f3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "18205292-e2aa-4d15-b282-90fb1856397f",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-16T15:41:24.9738187-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "04c65b55-52fe-437e-88a2-bc6fff9f6f54",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-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": "b6b96cf7-e91c-4748-a210-177d8a021cf2",
"Asset": {
"AssetId": "563cebcc-f529-436c-aaa8-8d486bab340b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "33b75378-4a0b-41ed-b355-1f1493154bfb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d1b0e7d4-c134-4680-aeaa-2faa1a96e696",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e8e0daf5-562c-430a-90cb-73054804c6a4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-16T15:41:24.9738187-08:00",
"MeasurementValueNeededDate": "2026-01-16T15:41:24.9738187-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "edc7b67b-f2c8-4032-9a13-0f8d144c4282",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-16T15:41:24.9738187-08:00",
"MeasurementValueNeededDate": "2026-01-16T15:41:24.9738187-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8e2f3397-4b3a-40f1-bce1-250b65e6ab31",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "bba4dec1-e325-444e-beab-b34c286e5a7a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1d761bfe-f7a8-4e47-ac67-f9c093706e78",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-16T15:41:24.9738187-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "06bf9aa7-0444-41e3-a0a2-00243ac26a79",
"CreateDate": "2026-01-16T15:41:24.9738187-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T15:41:24.9738187-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}