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": "b8785a83-0fea-465c-aa95-efe4b9b0b58b",
"Asset": {
"AssetId": "e5815520-2cf7-40d6-b95d-818dd60e66ca",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "71e82cb4-a9cb-41a9-8ab0-305ad688caf3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0adc2d38-6fe5-4fe6-83bd-aa914cf7293d",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9551440b-5ed4-40ba-b189-9495285b9586",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-23T17:27:15.188172-08:00",
"MeasurementValueNeededDate": "2026-01-23T17:27:15.188172-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "15bf5c94-3dc9-48c3-be59-39fc4d96ac1d",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-23T17:27:15.188172-08:00",
"MeasurementValueNeededDate": "2026-01-23T17:27:15.188172-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2c88ce90-4085-4662-8807-f0028165672c",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4d48b2b9-f5a4-4a17-a618-ec947feff9de",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7886bef0-2696-445d-9f24-d2aad5819048",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-23T17:27:15.188172-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2c9865f9-dfd9-406a-bc9d-78bf13e2cd99",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-23T17:27:15.188172-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": "cb8e1ce3-3a13-4eda-a286-f28af8bdb6f6",
"Asset": {
"AssetId": "3d8da55a-5870-40b3-8cbe-cddc1d94b686",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "610849fc-bde3-446b-a610-37156f6e260f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "305e859d-1c84-4687-aa5a-2c6d845da97a",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1f0cfd93-9628-456d-bb19-f7c85ec0ec94",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-23T17:27:15.188172-08:00",
"MeasurementValueNeededDate": "2026-01-23T17:27:15.188172-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "166505b7-32d8-4197-8306-93fdcaa15b03",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-23T17:27:15.188172-08:00",
"MeasurementValueNeededDate": "2026-01-23T17:27:15.188172-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ce46074b-3934-4245-b0d6-a079ba28665d",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "65bcf91d-9174-4574-9161-c9bca2ace81f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "17bca126-1cdf-43c3-87a4-8e5a70d8c571",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-23T17:27:15.188172-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "918c5d2b-f1f9-4c6c-bbf0-aa08369c2e34",
"CreateDate": "2026-01-23T17:27:15.188172-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-23T17:27:15.188172-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}