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": "a5911280-21cb-4bb3-af72-716617a20cbf",
"Asset": {
"AssetId": "c5013903-0d60-401b-bcae-238b5fa40c51",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f4663f46-b438-4879-9296-0842707c5a30",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "278d9be8-ecb8-41df-8392-0e7084a34547",
"CreateDate": "2026-06-30T11:44:47.3738185-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:44:47.3738185-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "72a0255a-8ba6-40a9-b768-0767200778e2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-30T11:44:47.3738185-07:00",
"MeasurementValueNeededDate": "2026-06-30T11:44:47.3738185-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fb85514f-7e9e-4925-9c81-f4f2b4565a4b",
"CreateDate": "2026-06-30T11:44:47.3738185-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T11:44:47.3738185-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-30T11:44:47.3738185-07:00",
"MeasurementValueNeededDate": "2026-06-30T11:44:47.3738185-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4d8c64e9-31d2-484a-9823-cb1c6b7e29b3",
"CreateDate": "2026-06-30T11:44:47.3738185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-30T11:44:47.3738185-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f0a18ece-e571-47af-83c7-f5ac0f0cd48e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4bc82662-cb77-4b9d-a19b-1b79ff5c5cc8",
"CreateDate": "2026-06-30T11:44:47.3738185-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-30T11:44:47.3738185-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-30T11:44:47.3738185-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "21f68adf-7167-4729-8b9a-fcc152969690",
"CreateDate": "2026-06-30T11:44:47.3738185-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-30T11:44:47.3738185-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": "c11cc71f-e002-43da-bc7b-f2bee058aa03",
"Asset": {
"AssetId": "a8892e9e-98ed-4980-9ffe-b5cbd1b1f086",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "30fd1f2a-896c-438c-85cc-4ec900e77519",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "536143db-9f19-4d5e-bc70-6aca9819064d",
"CreateDate": "2026-06-30T11:44:47.3894301-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:44:47.3894301-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "184ab163-6244-4bd0-b90b-d7feed3dad0d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-30T11:44:47.3894301-07:00",
"MeasurementValueNeededDate": "2026-06-30T11:44:47.3894301-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dc858bf9-c1b0-4186-aab1-7058ea52bfeb",
"CreateDate": "2026-06-30T11:44:47.3894301-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T11:44:47.3894301-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-30T11:44:47.3894301-07:00",
"MeasurementValueNeededDate": "2026-06-30T11:44:47.3894301-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "25961886-721d-45f1-bf0e-472b3eb4d801",
"CreateDate": "2026-06-30T11:44:47.3894301-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-30T11:44:47.3894301-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "7e12ba63-e91e-4c96-b6e2-447c090c2a09",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0f02d1bf-3869-40fd-8ecf-2dc846bd08c9",
"CreateDate": "2026-06-30T11:44:47.3894301-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-30T11:44:47.3894301-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-30T11:44:47.3894301-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3286c6d1-c11a-4cb5-b42b-39fbcb164df9",
"CreateDate": "2026-06-30T11:44:47.3894301-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-30T11:44:47.3894301-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}