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": "014386dc-f62d-448b-8486-84312ce008e8",
"Asset": {
"AssetId": "78829817-2569-45f3-b488-96d1d52b347e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ba1eaa66-ffe6-408f-8d77-a7c4c99b5af4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9d251f08-5c4e-4206-a0d0-166658197217",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c062ea18-7000-4de8-ad74-645b052b9b1d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T14:58:47.0793265-07:00",
"MeasurementValueNeededDate": "2026-03-24T14:58:47.0793265-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "36e94609-0bc8-45c2-a232-c7caaee39318",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-24T14:58:47.0793265-07:00",
"MeasurementValueNeededDate": "2026-03-24T14:58:47.0793265-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "633329e9-6e6e-4bea-8591-76fb306cb603",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8b55a102-cfe1-4dc7-86af-a3dbe66e7ef9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5849cd6c-c968-4e4b-8f0c-e2a864926f59",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-24T14:58:47.0793265-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "84590b3b-1127-4c52-a6a0-6fa2bfce03a2",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-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": "d3cb276a-2eea-4822-b2b8-3882f8773c16",
"Asset": {
"AssetId": "7271e4e7-a6b3-477c-82cd-ed2741512214",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e3adb9c1-a0a2-4747-b7b6-bd80aeedff28",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9ef073fc-1549-4fbb-9018-26583358fb07",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a9c83281-64c4-440e-9401-f33ec875b3e1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T14:58:47.0793265-07:00",
"MeasurementValueNeededDate": "2026-03-24T14:58:47.0793265-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "247b022d-0736-4489-bec9-410aa04b54fe",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-24T14:58:47.0793265-07:00",
"MeasurementValueNeededDate": "2026-03-24T14:58:47.0793265-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3f9f139d-7608-450d-a0b8-bbe946944467",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "03cb26b2-1881-4430-9e98-e6d7b17b6fbf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7ddd49cb-73ec-4e85-b233-cdf9e7721951",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-24T14:58:47.0793265-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cd41797b-7022-4a11-9022-8c74f9b6ce40",
"CreateDate": "2026-03-24T14:58:47.0793265-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T14:58:47.0793265-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}