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": "fbc81f7f-7f91-4e9c-b6a3-87656a150c7e",
"Asset": {
"AssetId": "cb5fa292-58a8-49e2-ae4e-db076b929ae3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fcff9e5d-0f3c-4c07-9593-e46c06d186be",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "02489307-a46f-4d8d-9857-2fba7fbdf473",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "88d17d00-0a6c-4691-bb40-84a3dd4c482d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-28T05:46:40.5389608-07:00",
"MeasurementValueNeededDate": "2026-09-28T05:46:40.5389608-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8d8d1f71-fa73-43e6-a2bb-aa5dce44aa02",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-28T05:46:40.5389608-07:00",
"MeasurementValueNeededDate": "2026-09-28T05:46:40.5389608-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "48b9cd7a-5c3c-448a-868f-2ef32c961acf",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8273b38d-d16f-4193-8340-eb36e83b2cf2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a5fbf66e-f0c9-4130-ab28-f4adbe8d4b41",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-28T05:46:40.5389608-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6b23cf64-fee1-4e8e-8ab7-5fc45b0cac43",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-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": "a1eb0e56-eefb-480d-9f7f-cf5fa6b4eeef",
"Asset": {
"AssetId": "8974aebc-a185-4c66-bfcd-183d3206732d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1aee57f7-9ff6-4b4a-9c84-99e65f63c15c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4716b009-f8a6-4d5e-a642-1bd64f1ab314",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6058c9fe-5ced-4224-be61-69bf18670f70",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-28T05:46:40.5389608-07:00",
"MeasurementValueNeededDate": "2026-09-28T05:46:40.5389608-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e4593248-c98d-40e7-88d8-1f4d3815cb0e",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-28T05:46:40.5389608-07:00",
"MeasurementValueNeededDate": "2026-09-28T05:46:40.5389608-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c81b6dd8-3705-449d-8108-6ff4fd6cf470",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d6496737-180b-4d4c-a2f1-1427b550ae11",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c3f2a464-2177-4f08-9fba-3de66301dc9b",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-28T05:46:40.5389608-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4380099e-0d88-4490-8d8d-f224968b8438",
"CreateDate": "2026-09-28T05:46:40.5389608-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T05:46:40.5389608-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}