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": "14d04028-ee6f-4363-8a78-443ca1a336b7",
"Asset": {
"AssetId": "003e5eec-88f4-426e-afec-815013fc9013",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3d3c87df-b598-4467-b4e4-abe79a6cfa81",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c3ea8727-b6a1-4edc-ac6e-ca21c1be092e",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c79a83ee-639a-4017-bbc6-77bad66920b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-21T00:21:58.7099193-07:00",
"MeasurementValueNeededDate": "2026-07-21T00:21:58.7099193-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a6c109f-c035-4c1f-926a-54a86e8c835f",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-21T00:21:58.7099193-07:00",
"MeasurementValueNeededDate": "2026-07-21T00:21:58.7099193-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5d4ffc82-3717-4580-b028-16b0fdc6cda1",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e6f3432d-4c95-4aac-88ac-97078ffc0a21",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ce17c6e0-0b05-43d7-8d59-54363ef1c229",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-21T00:21:58.7099193-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "30f44361-96fc-4a75-95e6-8e232d6842e6",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-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": "7aa7d103-b162-41f5-a458-ff44ff12aee3",
"Asset": {
"AssetId": "3f1ad031-53bf-4bda-bdc9-3e8e3dfb5887",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "331756d8-5b6c-4289-9655-65a17434865b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a7ff0b8b-bbfd-4516-b27e-d6168c4ad8d5",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "06c7a624-aaaf-4535-a23d-affae2ffd45c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-21T00:21:58.7099193-07:00",
"MeasurementValueNeededDate": "2026-07-21T00:21:58.7099193-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "30765c9f-40f3-42d8-b4d6-ec8a66f5468d",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-21T00:21:58.7099193-07:00",
"MeasurementValueNeededDate": "2026-07-21T00:21:58.7099193-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3d85e2f2-dc20-40cc-add9-384b691463a7",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e5383c25-4f65-4212-b4d1-b0ff02b0b4b4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5faaa443-218b-417d-ba68-f3f5d645b97b",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-21T00:21:58.7099193-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "65a0db2b-2360-468e-9605-f5f29ef32228",
"CreateDate": "2026-07-21T00:21:58.7099193-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-21T00:21:58.7099193-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}