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": "e5c7696f-abee-41cd-aedc-946c769317d3",
"Asset": {
"AssetId": "999ad1b0-5216-482c-acc9-c290b8faefa9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2b527426-a602-46aa-9f90-ab7e7326875a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "975a81a6-896a-4962-ab2d-e0005440b98d",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "86b94ac3-bc56-44ec-b75d-bbd5f8d8ed17",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-10T08:23:02.4427607-07:00",
"MeasurementValueNeededDate": "2026-06-10T08:23:02.4427607-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f6eccda5-cd47-4c70-9ffe-16e8f867299b",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-10T08:23:02.4427607-07:00",
"MeasurementValueNeededDate": "2026-06-10T08:23:02.4427607-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d8c4dbe0-b884-4a02-a09a-97b52d4bfe81",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "16b3ff2d-4345-4596-b8e3-e18283ad1efa",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1ebdd2ec-46a3-4c39-a366-3ce6d09716a7",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-10T08:23:02.4427607-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8dbc0ca8-961f-48f3-ab54-3ad9c8704eaa",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-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": "1a07352f-fa85-45e2-a39a-7e50e6e69bae",
"Asset": {
"AssetId": "393e5a24-b1e6-445d-a7c8-727e4739fac6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8198e887-dcca-4a46-93e2-38843a06a3bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "83940997-0b21-453e-ab95-413cb4a808b1",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "073dad3e-d4c5-46dd-8bbc-c0cbf9082038",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-10T08:23:02.4427607-07:00",
"MeasurementValueNeededDate": "2026-06-10T08:23:02.4427607-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "49fa7743-f252-4fa0-8277-f8a2f63cbc9e",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-10T08:23:02.4427607-07:00",
"MeasurementValueNeededDate": "2026-06-10T08:23:02.4427607-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "21dce196-f0c5-47fd-957a-81ab07ae4aca",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "43d21fc7-c6a3-44f4-951c-ceb832cdb7a0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0f09dea2-2c63-456e-9001-d73fc859ed16",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-10T08:23:02.4427607-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b3bc6a19-2622-4807-9535-3af7c01f26c0",
"CreateDate": "2026-06-10T08:23:02.4427607-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-10T08:23:02.4427607-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}