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": "5b4475ff-120a-4367-8dd1-c834e7d995a1",
"Asset": {
"AssetId": "6832d9bf-1667-4dc7-a49d-5d395350b9ce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0cc4d8e4-d4d6-4b28-8d28-fd9ff992cda5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "834d03cd-3b09-4312-bc9f-64b11a199db7",
"CreateDate": "2025-10-31T23:50:23.205661-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-31T23:50:23.205661-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "2299a450-8410-43b1-a1a9-7dc75496149e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-31T23:50:23.205661-07:00",
"MeasurementValueNeededDate": "2025-10-31T23:50:23.205661-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "835294a0-f2d4-4812-93ee-ba16a775e917",
"CreateDate": "2025-10-31T23:50:23.205661-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-31T23:50:23.205661-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-31T23:50:23.205661-07:00",
"MeasurementValueNeededDate": "2025-10-31T23:50:23.205661-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4886469c-8d89-47b8-8b75-4b55910d7f91",
"CreateDate": "2025-10-31T23:50:23.205661-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-31T23:50:23.205661-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e96b81e3-eabc-482d-94ab-098607257c72",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ed82a695-4bad-4129-81a8-a045384d7c4a",
"CreateDate": "2025-10-31T23:50:23.205661-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-31T23:50:23.205661-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-31T23:50:23.205661-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b1925e13-1026-4f23-be97-47827c384937",
"CreateDate": "2025-10-31T23:50:23.205661-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-31T23:50:23.205661-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": "0f8d9b85-6927-432d-a339-db24cd1a85f5",
"Asset": {
"AssetId": "8f2e8603-2a96-44c6-bae8-9d3383649209",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "619e27a2-1f4c-4d21-a558-81eb545689b5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "169bd161-8a7b-490b-98f7-5f8f746d1ce9",
"CreateDate": "2025-10-31T23:50:23.252534-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-31T23:50:23.252534-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bdcbc7e5-a549-4d1f-b21f-8fd9fcf4deba",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-31T23:50:23.252534-07:00",
"MeasurementValueNeededDate": "2025-10-31T23:50:23.252534-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "42054530-7a3a-4bb6-852c-19ffe8ace00f",
"CreateDate": "2025-10-31T23:50:23.252534-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-31T23:50:23.252534-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-31T23:50:23.252534-07:00",
"MeasurementValueNeededDate": "2025-10-31T23:50:23.252534-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8b58f554-daca-4957-9884-d79ea5cfbba8",
"CreateDate": "2025-10-31T23:50:23.252534-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-31T23:50:23.252534-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5dde3029-9d71-4c59-a2e6-7695ed8ef2db",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "455d6188-4110-44f9-bac3-0c8d29913d64",
"CreateDate": "2025-10-31T23:50:23.252534-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-31T23:50:23.252534-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-31T23:50:23.252534-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "24e74583-39f4-48a9-8593-fedcf289f999",
"CreateDate": "2025-10-31T23:50:23.252534-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-31T23:50:23.252534-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}