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": "828cdd6e-f313-4c45-9b11-4be257ad0b86",
"Asset": {
"AssetId": "842b4d37-f41a-40fc-813a-abcf12dc4a1f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4bfa419c-6cbb-4d8f-b5a7-ca5775e81aed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d2f22731-c301-49b4-9bc5-29415d7ac3c2",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9251239d-220d-4d7e-a723-469e354b0504",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-26T20:24:26.5345425-07:00",
"MeasurementValueNeededDate": "2025-06-26T20:24:26.5345425-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ed47ba1b-ac49-4009-b3ed-d6a578f8397f",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-26T20:24:26.5345425-07:00",
"MeasurementValueNeededDate": "2025-06-26T20:24:26.5345425-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b12b0bad-4ef3-482e-aa77-4c570e755a06",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "bd9b6195-8fcc-4616-b9b8-b23ff9efbf0f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9620c0f1-343a-441c-830e-9a6244a1756d",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-26T20:24:26.5345425-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9f252ecd-4662-4bb3-8e78-e4f4dceadbab",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-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": "72c552e6-c5c7-4724-ba78-a5e9271a9999",
"Asset": {
"AssetId": "14e6e9cb-73ac-42bb-98f7-dbd5bbc0f481",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ae726ea0-769e-47a8-bd11-63476c5692ef",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bec5b97b-e7f0-4d2b-857e-4f0e7323c932",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5506fcb4-d5b5-4dae-82c0-9a9d0feb9769",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-26T20:24:26.5345425-07:00",
"MeasurementValueNeededDate": "2025-06-26T20:24:26.5345425-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5595210-1d04-4ce2-96da-bb26a2036fcd",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-26T20:24:26.5345425-07:00",
"MeasurementValueNeededDate": "2025-06-26T20:24:26.5345425-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e688e9ad-80ae-42d4-906a-ea76c14e8923",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "6ded90a7-18a0-45ef-8761-6737e391d067",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "842c3054-aad1-43da-a820-354193892714",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-26T20:24:26.5345425-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "524bbedb-094c-4f80-94b8-0a2b8ffe1693",
"CreateDate": "2025-06-26T20:24:26.5345425-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-26T20:24:26.5345425-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}