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": "0c6a34ac-f7d1-4b0b-a248-e7e02d17322e",
"Asset": {
"AssetId": "c4bd7360-8c71-4799-950b-037b2f7a3c12",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "42894e13-7448-4dc9-9ac1-e70af34e47a4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "649ec2dd-8f85-4ace-96b9-883d13565bb4",
"CreateDate": "2025-10-13T17:29:59.2331695-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T17:29:59.2331695-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5b5e4bd4-79fc-4554-8250-a334d4f1e959",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T17:29:59.2331695-07:00",
"MeasurementValueNeededDate": "2025-10-13T17:29:59.2331695-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "745ce96c-2233-42ed-a9fe-9bf00afeff0b",
"CreateDate": "2025-10-13T17:29:59.2331695-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T17:29:59.2331695-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-13T17:29:59.2331695-07:00",
"MeasurementValueNeededDate": "2025-10-13T17:29:59.2331695-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d577639d-ce8f-413e-bd70-c9d7551f1981",
"CreateDate": "2025-10-13T17:29:59.2331695-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T17:29:59.2331695-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "bbeae5a7-588e-4397-a0ca-0aad87c039ef",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5f4089f2-3d57-43a6-b14b-65bcaca76a93",
"CreateDate": "2025-10-13T17:29:59.2331695-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T17:29:59.2331695-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T17:29:59.2331695-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5ee63793-5078-4e4a-81b3-1cd56cc03082",
"CreateDate": "2025-10-13T17:29:59.2331695-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T17:29:59.2331695-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": "10e183c0-96bc-45d9-b5f0-e8022fe50b5d",
"Asset": {
"AssetId": "eda79257-f72b-4cd1-a85e-4257da387a4b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a97818ab-3677-4712-938c-ef620de6c028",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6861a39c-77e8-4d35-9d65-7ca4bb362ce7",
"CreateDate": "2025-10-13T17:29:59.2488468-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T17:29:59.2488468-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e809ed33-a083-4240-b63e-3c2a45eec00d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T17:29:59.2488468-07:00",
"MeasurementValueNeededDate": "2025-10-13T17:29:59.2488468-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a428c3fd-f5fb-4ff8-b43f-f3591e47f190",
"CreateDate": "2025-10-13T17:29:59.2488468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T17:29:59.2488468-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-13T17:29:59.2488468-07:00",
"MeasurementValueNeededDate": "2025-10-13T17:29:59.2488468-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "996523c5-c832-4bd5-90f2-34519834589f",
"CreateDate": "2025-10-13T17:29:59.2488468-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T17:29:59.2488468-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8faae450-6c4a-4a62-9626-89d424669f03",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ffd6e3b5-7301-47ca-8fdc-c0bdca5964b7",
"CreateDate": "2025-10-13T17:29:59.2488468-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T17:29:59.2488468-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T17:29:59.2488468-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4014d66c-86fc-4ff9-aed7-5302fbdacc36",
"CreateDate": "2025-10-13T17:29:59.2488468-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T17:29:59.2488468-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}