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": "fb2b53f3-f00d-4c4b-b3f1-7f4765189b82",
"Asset": {
"AssetId": "7c4843a6-ffdb-4ab5-b87e-a7f5dbe57892",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "abc5b71e-260c-4326-a7c1-5356b589fa92",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b96c1857-b0a4-4e3b-a325-8406b9f42023",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "19ea88d5-df6d-4c4e-8cf6-0026f5e87bcc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-10T14:52:21.2687567-07:00",
"MeasurementValueNeededDate": "2025-10-10T14:52:21.2687567-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "14619f45-1f1e-478c-a463-2439818ae041",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-10T14:52:21.2687567-07:00",
"MeasurementValueNeededDate": "2025-10-10T14:52:21.2687567-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0ead1d8f-70e7-4786-86d4-d1eebcb6fce5",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b9de1aba-37cf-4c92-8627-4e37811a0b95",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "364e6221-9aae-4c18-af1e-731c40a8bffc",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-10T14:52:21.2687567-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a37c289a-86ce-4adc-8cba-658546e20913",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-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": "781a5c9f-aa80-4197-9bcf-82bb1d80ae3f",
"Asset": {
"AssetId": "3df5033d-bc83-460e-87c0-f266df1495cb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8ca7b071-d54a-4245-80cb-781235b5e2aa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "399d9f9a-94f7-4829-b0c0-c7d340ad3700",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3c0e59c9-a7c8-4255-859d-9d68e366af86",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-10T14:52:21.2687567-07:00",
"MeasurementValueNeededDate": "2025-10-10T14:52:21.2687567-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d4187b77-2e98-4664-9478-c9bdc9b828e2",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-10T14:52:21.2687567-07:00",
"MeasurementValueNeededDate": "2025-10-10T14:52:21.2687567-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9ccb7682-3ebd-4c35-bc10-23791e40e4ab",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d29e5287-903c-447e-b67a-f584930daeeb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8bfb6e38-20c1-460a-9fd3-99c351fe8754",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-10T14:52:21.2687567-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "122a2361-a5b2-4f07-a169-f1e048e9954e",
"CreateDate": "2025-10-10T14:52:21.2687567-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-10T14:52:21.2687567-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}