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": "d3c9d081-3b52-4aac-ae67-58fbcd9639d6",
"Asset": {
"AssetId": "c0857b9c-2601-4d65-a029-4fcbc163014c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b4350ff8-0878-47da-90f7-0f8c52d6ccdf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3099aeca-9f1e-402d-a2a2-b5eb76f503f3",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3d038af4-63ed-4c0a-ac01-a9355303b050",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-09T03:11:55.3574869-08:00",
"MeasurementValueNeededDate": "2024-12-09T03:11:55.3574869-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a648c1b1-64e4-4418-b3eb-a6e8de66adfd",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-09T03:11:55.3574869-08:00",
"MeasurementValueNeededDate": "2024-12-09T03:11:55.3574869-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d0929259-84f0-48b9-b96b-79e48b1e996e",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5631f0e5-9f88-442d-a4e1-a73abbd17437",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9205d9c4-7210-4c95-a230-af9319c4d24b",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-09T03:11:55.3574869-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "03633502-40ff-4e69-8460-4a7c29729c0e",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08: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": "2b6d0f1b-b65d-4b7a-bb86-c97ff34da565",
"Asset": {
"AssetId": "890c03b8-136e-41bb-a140-820bd71efab5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ef267754-9de2-409c-9218-145cea3c4b90",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7e3a2d60-a9f2-484d-899d-2f07da539330",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "22f83a19-6e65-42c8-a3c5-fd360548c048",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-09T03:11:55.3574869-08:00",
"MeasurementValueNeededDate": "2024-12-09T03:11:55.3574869-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2efd196e-3515-4027-9aa3-0dfec26906c1",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-09T03:11:55.3574869-08:00",
"MeasurementValueNeededDate": "2024-12-09T03:11:55.3574869-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "14ff8911-3f0c-47bf-835c-b16e0b1bc167",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a28af887-8d1f-41f8-864d-cdf8032e94d6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "241aee08-6749-48d1-943c-27bd3226036c",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-09T03:11:55.3574869-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "71aa5ae7-96bb-44b9-9c62-f93178360821",
"CreateDate": "2024-12-09T03:11:55.3574869-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-09T03:11:55.3574869-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}