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": "b7c61507-c0bc-4437-b906-125741346402",
"Asset": {
"AssetId": "06350386-0cc8-4ef7-b99e-c58ef211781d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8da3259c-97fe-4aa8-ae30-8877ebd1a2a7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "77729f54-54a8-4bfb-8199-d6bfd621348e",
"CreateDate": "2025-06-02T08:02:04.8034629-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T08:02:04.8034629-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9e59ee7d-1922-4168-841f-225a44e2dde5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T08:02:04.8034629-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:02:04.8034629-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2544b4a4-1cf4-4419-9dad-e9b3a1ccfffc",
"CreateDate": "2025-06-02T08:02:04.8034629-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:02:04.8034629-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-02T08:02:04.8034629-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:02:04.8034629-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "58e45838-084d-404f-b18e-3ae0f0e185d9",
"CreateDate": "2025-06-02T08:02:04.8034629-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T08:02:04.8034629-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4d80430c-8151-414b-9886-8e95dd1bcace",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "70033adb-9a90-4409-a4c2-095dca0bd7b1",
"CreateDate": "2025-06-02T08:02:04.8034629-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:02:04.8034629-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T08:02:04.8034629-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1e90253e-5cef-4fb8-b156-e96ebdf7ae19",
"CreateDate": "2025-06-02T08:02:04.8034629-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:02:04.8034629-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": "3ae37589-0af3-493c-ac98-15e9aa2ed24b",
"Asset": {
"AssetId": "676ebe6c-3fbe-4c8d-ad06-1608ed757cf8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "acd42dfa-6bff-4000-9258-54e8e77ede32",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "57b901d0-bd55-4318-8c8a-c4a7f1c76e1b",
"CreateDate": "2025-06-02T08:02:04.8189923-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T08:02:04.8189923-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "87f00d1d-5b02-4b3c-9c73-f9ba8badf3c0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T08:02:04.8189923-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:02:04.8189923-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5ad249eb-9d31-467d-b0ff-7c0934e59ff6",
"CreateDate": "2025-06-02T08:02:04.8189923-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:02:04.8189923-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-02T08:02:04.8189923-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:02:04.8189923-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ecf653e0-b1b0-4ade-b0de-f7eedd9da55d",
"CreateDate": "2025-06-02T08:02:04.8189923-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T08:02:04.8189923-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ba37e862-83e8-4be3-b533-c63e4933d413",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "892e66ed-69d6-414e-9e1d-82a1c8596939",
"CreateDate": "2025-06-02T08:02:04.8189923-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:02:04.8189923-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T08:02:04.8189923-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "31dbc77a-5d74-4881-8624-251c22229e45",
"CreateDate": "2025-06-02T08:02:04.8189923-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:02:04.8189923-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}