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": "a60dbf5c-84ea-44e0-846a-f56ddc257906",
"Asset": {
"AssetId": "807b160a-17bd-4362-82d3-f005dff7a125",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "15bebf06-e2c2-4829-995b-1ac6ba2e4490",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "765f2487-4d03-4d3d-8e6a-ebaf4f18e65d",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b6a0edee-4f77-4d96-8e5c-7cc4a0b6d167",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-31T16:28:35.5910245-08:00",
"MeasurementValueNeededDate": "2025-12-31T16:28:35.5910245-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4133fd82-7d75-42f9-acba-00e098b9a9aa",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-31T16:28:35.5910245-08:00",
"MeasurementValueNeededDate": "2025-12-31T16:28:35.5910245-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7dedf010-40ca-4237-b132-7b80c7639e86",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f14c8a07-0666-41b5-8a83-131cefd43ff6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d3ec0f5d-c959-4538-ae4e-697edad9ce4e",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-31T16:28:35.5910245-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ccef0352-2a29-4ce5-a8d4-9d04bcebc33b",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-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": "478bad34-7412-4370-bf2f-8bec36fc6be5",
"Asset": {
"AssetId": "bda6f89a-b7b0-4a5e-a4fc-3604c8247ffe",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ace3e31f-4f16-4773-8336-0933a6c19c05",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "49a6b803-ee4d-40d4-9942-5f2eecf13538",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "2abb81c8-abb7-491a-b2ae-e2198cceaf44",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-31T16:28:35.5910245-08:00",
"MeasurementValueNeededDate": "2025-12-31T16:28:35.5910245-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2e83f7e5-32f7-40f8-b49c-3587e738f6f4",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-31T16:28:35.5910245-08:00",
"MeasurementValueNeededDate": "2025-12-31T16:28:35.5910245-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ec891e33-6892-4794-a700-bd9a3d02cfb7",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "23d31ad4-4ad8-4dc5-863d-71e50d0bd03d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8b61faf4-5052-4d00-bf21-db73a9a74619",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-31T16:28:35.5910245-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aa65a658-8a59-420e-a84e-41e0a619a4fb",
"CreateDate": "2025-12-31T16:28:35.5910245-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-31T16:28:35.5910245-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}