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": "9954ee1c-45e0-40a6-84ae-9932614d5937",
"Asset": {
"AssetId": "f022f4cb-7958-487a-a0e4-20ca6f0f52db",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0aff445d-47d9-4842-8221-2ba306275234",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b95a63e4-bc8a-46f0-b6ea-b07a67eaa03c",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "29b48c67-38fc-4fa5-b5c7-ae042e4b4c52",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:01:04.4012431-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:01:04.4012431-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eadd142e-f13f-4c45-88da-14d1a2ae59dd",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-16T14:01:04.4012431-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:01:04.4012431-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4403b298-94b2-4f33-b240-389bbb256e28",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1313c1f1-3dbf-4b38-835d-956e97aa1786",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0f99d74f-3823-4268-92af-f4320e36072d",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-16T14:01:04.4012431-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2ad01a76-f38e-45d1-b4a7-e259d14a5400",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-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": "c83c727c-f2d1-4c30-b272-34967fdb9a20",
"Asset": {
"AssetId": "3184f4a9-04ee-40cb-af57-4477b060e0eb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1da6a1fc-84af-417f-99aa-690cdcfb00ee",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "be2d8cd5-65f1-4cb9-82fa-f1d55e630262",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "97427aba-7e64-4fe5-960a-8f0bf74b13e1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:01:04.4012431-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:01:04.4012431-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "048c2b21-4db6-4e07-aed2-6aabaeb54d91",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-16T14:01:04.4012431-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:01:04.4012431-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "05384320-4648-4805-9428-ed0cfc9b2d4d",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1f2b90c9-8aff-4b8e-8719-6978c39c5142",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "697bedf3-45c1-4e4e-86e1-e9ae7f601e98",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-16T14:01:04.4012431-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e7040c4e-0e32-4064-8156-012c34b4077a",
"CreateDate": "2025-06-16T14:01:04.4012431-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-16T14:01:04.4012431-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}