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": "92f13315-b20d-4ed9-a83a-d053e59f1942",
"Asset": {
"AssetId": "5dcf2103-c567-4ec5-a84f-c56e61e9ac0b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0e7c8f23-9560-45cf-b57b-da78459ec763",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "707466f3-f6c0-492d-bbd5-3e15236463b3",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9f6a17da-438f-4e8e-ac76-4bfc3fe2a329",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-25T18:38:47.4480112-07:00",
"MeasurementValueNeededDate": "2025-10-25T18:38:47.4480112-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5b0a0835-9918-465f-87e0-4dfc6f296519",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-25T18:38:47.4480112-07:00",
"MeasurementValueNeededDate": "2025-10-25T18:38:47.4480112-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7da6757e-16e3-4401-886f-b0bc5ff5e2ee",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a0f62c3a-5721-4978-be3e-ec990764f83b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "12851751-e5ac-4254-a55d-bf31fa78de30",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-25T18:38:47.4480112-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f7f570c1-40da-440d-a4ec-27aa75a34682",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-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": "5bece292-ddb6-4960-b55f-8322c39d3afe",
"Asset": {
"AssetId": "fc3661f5-be55-4e2a-ad84-25578daf88ae",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b30f4733-3093-48f0-9b6e-250255565961",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "34a1f00d-f182-403d-9950-95c944a5a1dd",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f98d8883-ae37-43f0-ac5e-6e91fb4b625a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-25T18:38:47.4480112-07:00",
"MeasurementValueNeededDate": "2025-10-25T18:38:47.4480112-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c883a63e-7e8f-4ff6-a66a-4cbfa2513cc0",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-25T18:38:47.4480112-07:00",
"MeasurementValueNeededDate": "2025-10-25T18:38:47.4480112-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ee41cb64-cafb-4553-bd1e-af84784d10db",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ef0b877f-6398-41ac-ba28-1b5930a79746",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e9a04c8b-f7fa-47c9-b76e-c4d16aeee82b",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-25T18:38:47.4480112-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0c135178-89df-4a56-95c7-cf151145539b",
"CreateDate": "2025-10-25T18:38:47.4480112-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-25T18:38:47.4480112-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}