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": "0733ebae-fdb1-4026-8dc1-48ee3142279a",
"Asset": {
"AssetId": "50a564b2-5b1d-42f6-ac0e-9e7af8026c27",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a0e3050b-8371-4cbb-a9aa-8bbb31a3bb73",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "31a2296a-4977-4b09-b720-4b0d6e8673af",
"CreateDate": "2026-09-02T00:31:22.249089-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:31:22.249089-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f06bb16f-60e8-42af-8938-cdfc18147ec5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T00:31:22.249089-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:31:22.249089-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1f859735-4cd0-4f15-9a44-d9f43d76484f",
"CreateDate": "2026-09-02T00:31:22.249089-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:31:22.249089-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-02T00:31:22.249089-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:31:22.249089-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f4e591a9-be34-4b74-bf3d-c0bb86263f72",
"CreateDate": "2026-09-02T00:31:22.249089-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-02T00:31:22.249089-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f20802db-dd73-459d-8c4d-910d5bc83420",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fb255f6b-a3bd-4efc-9c13-e6366378e105",
"CreateDate": "2026-09-02T00:31:22.249089-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:31:22.249089-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-02T00:31:22.249089-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2b04062b-90ca-4d37-950a-d594eb9c9f98",
"CreateDate": "2026-09-02T00:31:22.249089-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:31:22.249089-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": "6d6eb160-7991-4707-bb78-b8b03f0b4a07",
"Asset": {
"AssetId": "8ea1665c-8132-4c61-8147-a606fef28069",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "64e4af42-27c4-429b-a8cd-2b5c1a522ba1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3e1c3472-5913-4940-96ce-64576d245c0f",
"CreateDate": "2026-09-02T00:31:22.2646635-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:31:22.2646635-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "421f83ca-a694-4033-985b-617e45fa6681",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T00:31:22.2646635-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:31:22.2646635-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9de89adc-4ed6-43a6-8473-144c6aefac5e",
"CreateDate": "2026-09-02T00:31:22.2646635-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:31:22.2646635-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-02T00:31:22.2646635-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:31:22.2646635-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7f690c13-d58a-4ce1-a72c-3598011f4e14",
"CreateDate": "2026-09-02T00:31:22.2646635-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-02T00:31:22.2646635-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "13094ebf-7a10-4014-9eaf-22479d545856",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "704c9afa-2702-4283-beea-da8fe7987234",
"CreateDate": "2026-09-02T00:31:22.2646635-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:31:22.2646635-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-02T00:31:22.2646635-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "57e8086a-1af8-465b-8414-50c50f243a9b",
"CreateDate": "2026-09-02T00:31:22.2646635-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:31:22.2646635-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}