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": "9e7201b8-7598-44b9-b5a5-d1534b2fa6d1",
"Asset": {
"AssetId": "8cd50256-9989-4605-9086-267bbd50cbe5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "16ec1806-521e-412b-b575-51b8763f8179",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e1375ec6-43d5-4d76-a19b-68851d6842d4",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4810b0d7-273a-4018-8870-9fc9f5997a73",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-20T19:13:57.948859-07:00",
"MeasurementValueNeededDate": "2026-05-20T19:13:57.948859-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a3e464f-1534-41a1-9160-a4e30839c4b4",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-20T19:13:57.948859-07:00",
"MeasurementValueNeededDate": "2026-05-20T19:13:57.948859-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "300b996c-d5bb-4d11-9b56-c544ffc0d5e1",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "85370e42-590e-4479-a3f4-6609a2a4e72c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "08cd06f2-012d-4def-9837-799b2c975467",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-20T19:13:57.948859-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0820cbb2-6b3c-440b-85c5-03f88d04375f",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-20T19:13:57.948859-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": "e21bbd21-d11a-4a7a-b970-2abc002ccf9d",
"Asset": {
"AssetId": "5459a8c1-db08-40e2-ac0b-d48c5a7102b3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "be637065-55f9-4fac-b26c-1065ee995512",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a84a8b16-c387-4665-9fb1-b8d36f5eb019",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b4fdfcd9-97f8-493e-b32f-38724e9a5dca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-20T19:13:57.948859-07:00",
"MeasurementValueNeededDate": "2026-05-20T19:13:57.948859-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "da33a171-4422-42b3-8150-3eb39dac3886",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-20T19:13:57.948859-07:00",
"MeasurementValueNeededDate": "2026-05-20T19:13:57.948859-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2baef7cb-e853-4c45-a28b-90927fef2c70",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "72817c5a-4d7e-44b2-9404-d4f69ace9eaf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d8485e8c-6f24-4437-9c43-538777069425",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-20T19:13:57.948859-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fd5b75ca-c7c9-4069-981d-1d9d7f261fac",
"CreateDate": "2026-05-20T19:13:57.948859-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-20T19:13:57.948859-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}