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": "3ad365fa-3280-4d2b-aa89-4811f36e98e1",
"Asset": {
"AssetId": "30cbae25-caf1-4fe0-9e6b-4eea49700652",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2a1efa79-d576-46f7-8b6e-b0db5f500e93",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cd2912c4-5443-4abb-9931-ab620ce1e7a0",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6aeda49a-235a-4ffa-b2e5-dfd12ed1fc02",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-28T18:02:39.7292951-07:00",
"MeasurementValueNeededDate": "2026-09-28T18:02:39.7292951-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9fa700cd-cca3-4728-85b1-c7d8a5cd615b",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-28T18:02:39.7292951-07:00",
"MeasurementValueNeededDate": "2026-09-28T18:02:39.7292951-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5aaacf70-f8eb-4ec2-bb90-4acf463cfbd6",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "969976ac-df39-4291-9a00-9842bc5dbce3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "93311316-5744-4365-a74a-2630bcec4166",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-28T18:02:39.7292951-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dc7b5da7-c96e-4615-97ef-4a9f666fd648",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-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": "2c1bcee5-cb8c-4d18-9234-f37fbad5dac6",
"Asset": {
"AssetId": "f15c7677-9fe6-4dec-8d70-baae7abef89a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9a6cf57a-f70c-4d73-aa2a-11efce8f9439",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c83f643a-f599-44ff-98c1-e0bf3077b009",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8829704b-7946-4a4e-898d-46c003d7168b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-28T18:02:39.7292951-07:00",
"MeasurementValueNeededDate": "2026-09-28T18:02:39.7292951-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "aa789a4c-d0e2-49e9-a143-c7f2306d4dc3",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-28T18:02:39.7292951-07:00",
"MeasurementValueNeededDate": "2026-09-28T18:02:39.7292951-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "254f0d63-889d-40ee-8db1-9a1baa7516fb",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f2696e11-8f2b-4b4b-8950-1968878ab24c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "43e0a4c3-a10b-4d0b-9888-00b5245567ed",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-28T18:02:39.7292951-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "373338c5-8e51-430f-9ce0-c51212e53911",
"CreateDate": "2026-09-28T18:02:39.7292951-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T18:02:39.7292951-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}