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": "1d0b4f78-839d-414e-9017-6fb697b3f2d9",
"Asset": {
"AssetId": "42027a54-73ea-406b-8ccd-2ad34769bbb9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0bd72d85-d9ca-42f5-884f-a53075251264",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d6a067b9-d605-48a0-a98a-b32a564fbf1f",
"CreateDate": "2025-08-30T09:33:11.1327357-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-30T09:33:11.1327357-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "39cb4fc3-1bb0-4ba6-b869-7e36f15545ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-30T09:33:11.1327357-07:00",
"MeasurementValueNeededDate": "2025-08-30T09:33:11.1327357-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "482fd42c-dd08-4c82-b15a-83c8bde42285",
"CreateDate": "2025-08-30T09:33:11.1327357-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-30T09:33:11.1327357-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-30T09:33:11.1327357-07:00",
"MeasurementValueNeededDate": "2025-08-30T09:33:11.1327357-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1b62bb0e-be8b-4dbd-8f64-241ee596893e",
"CreateDate": "2025-08-30T09:33:11.1327357-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-30T09:33:11.1327357-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2c4fd984-1f18-4251-9ac7-1cbc656d40e9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "736e095f-ce4c-4531-8313-cc669facde5d",
"CreateDate": "2025-08-30T09:33:11.1327357-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T09:33:11.1327357-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-30T09:33:11.1327357-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f9253679-5e4e-4293-a765-7d2147c37f87",
"CreateDate": "2025-08-30T09:33:11.1327357-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T09:33:11.1327357-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": "ea538151-96c9-425f-9ae5-abb3e7dccd73",
"Asset": {
"AssetId": "a1b10967-d386-4b26-8f07-e5303cba844d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "173494d7-5195-42a1-89fa-39056290b630",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed73873f-163b-455c-aa63-c09fc2a0bb08",
"CreateDate": "2025-08-30T09:33:11.2421096-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-30T09:33:11.2421096-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "63d1d570-84bf-49f6-a28a-64e27961b3ad",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-30T09:33:11.2421096-07:00",
"MeasurementValueNeededDate": "2025-08-30T09:33:11.2421096-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c37f1d55-6022-48e7-be91-5215408e3434",
"CreateDate": "2025-08-30T09:33:11.2421096-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-30T09:33:11.2421096-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-30T09:33:11.2421096-07:00",
"MeasurementValueNeededDate": "2025-08-30T09:33:11.2421096-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b5d61f40-8232-490a-b762-7e44ced995b2",
"CreateDate": "2025-08-30T09:33:11.2421096-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-30T09:33:11.2421096-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "697b9538-1154-4e93-ac74-135cfe892e94",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "eb3e1c9e-3239-44f5-95ac-a0c43f2b888d",
"CreateDate": "2025-08-30T09:33:11.2421096-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T09:33:11.2421096-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-30T09:33:11.2421096-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1a133a6e-6c16-484b-a02f-9967c04afcbc",
"CreateDate": "2025-08-30T09:33:11.2421096-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-30T09:33:11.2421096-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}