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": "bb59c69d-c427-4661-9324-9f5ca2090911",
"Asset": {
"AssetId": "c6ddf2fa-9e61-4384-8cba-516cde5892f9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "abc18276-2cc4-4673-994b-98c90ff89c6b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f0991f7e-eb5a-484c-ac60-ab5ac3c90e67",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "cb6297f5-84c0-4982-8f22-a4f34cf04b4a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-16T07:35:21.9419834-07:00",
"MeasurementValueNeededDate": "2026-08-16T07:35:21.9419834-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a4cd3aae-830b-45e7-af02-05535acb3af4",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-16T07:35:21.9419834-07:00",
"MeasurementValueNeededDate": "2026-08-16T07:35:21.9419834-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6a0d97bf-8808-4331-954b-2e2c0d0dff84",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "11f0c265-301a-4d4f-9294-a5c3a7a6587b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "696f391e-3e93-4338-bbb7-70f40b335212",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-16T07:35:21.9419834-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6dd0ceca-2e75-409e-bce3-44b716b4a37c",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-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": "9a7ce24a-224d-4b96-845a-431a025f0043",
"Asset": {
"AssetId": "138cd41f-a15c-487d-8116-b02d12f66b78",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5abc3b44-7b3f-4fdb-9a91-049a900e8a4c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f1b76173-ae66-4c1b-ac7c-34162e3b94b1",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0261c865-0aee-4533-bf96-4604b48c128d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-16T07:35:21.9419834-07:00",
"MeasurementValueNeededDate": "2026-08-16T07:35:21.9419834-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "34c3c0f0-14a4-4bd1-8f84-782bff4342ee",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-16T07:35:21.9419834-07:00",
"MeasurementValueNeededDate": "2026-08-16T07:35:21.9419834-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e797540c-a476-4d26-8655-7229a3955689",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5870e1e6-e720-48d8-bf8b-9bc9e691e261",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a3d42fc4-9876-4217-9701-839eede1aff7",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-16T07:35:21.9419834-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c36ae652-c298-4006-91f0-2177eb0fde32",
"CreateDate": "2026-08-16T07:35:21.9419834-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-16T07:35:21.9419834-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}