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": "e8265bae-c9c0-4c1f-9feb-1c583307d6db",
"Asset": {
"AssetId": "a8bc14e1-dced-4cd6-9054-d8211ed1ec44",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3cd7d74d-2dca-46b3-9ace-b1a6f1476a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "74479eed-cbf2-4aca-9ea6-c323695529a2",
"CreateDate": "2025-06-23T00:05:23.0239522-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-23T00:05:23.0239522-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fcf1b39b-fe60-4b71-8cc1-696e5ec362d5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-23T00:05:23.0239522-07:00",
"MeasurementValueNeededDate": "2025-06-23T00:05:23.0239522-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a8602f34-75ac-4987-87b9-c4c798afb7da",
"CreateDate": "2025-06-23T00:05:23.0239522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-23T00:05:23.0239522-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-23T00:05:23.0239522-07:00",
"MeasurementValueNeededDate": "2025-06-23T00:05:23.0239522-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b082a4f1-8a10-48e1-9bee-cea45f3a9cde",
"CreateDate": "2025-06-23T00:05:23.0239522-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-23T00:05:23.0239522-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "00ba7e49-0038-4f63-9d2a-77b603beb54c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "39301594-7e66-4e4b-be6d-1a9f87920347",
"CreateDate": "2025-06-23T00:05:23.0239522-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-23T00:05:23.0239522-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-23T00:05:23.0239522-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7a806916-ee8e-4f8e-82f3-80d4aa22c5e1",
"CreateDate": "2025-06-23T00:05:23.0239522-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-23T00:05:23.0239522-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": "34a4e9c4-e223-43db-9501-6675f605358b",
"Asset": {
"AssetId": "550d7908-69d1-4542-925a-a2298d8040e6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "02db4809-c0ca-464e-aee0-a40080d74933",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3111ef79-d464-47cf-a478-e70e1728e962",
"CreateDate": "2025-06-23T00:05:23.0395703-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-23T00:05:23.0395703-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "32f10cb7-e9f7-4453-8be0-9f875dda268e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-23T00:05:23.0395703-07:00",
"MeasurementValueNeededDate": "2025-06-23T00:05:23.0395703-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a8c4c809-9e05-4748-99f8-af0ef0827e07",
"CreateDate": "2025-06-23T00:05:23.0395703-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-23T00:05:23.0395703-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-23T00:05:23.0395703-07:00",
"MeasurementValueNeededDate": "2025-06-23T00:05:23.0395703-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f62d465d-6fc9-4c38-bf94-c129fd5dcb48",
"CreateDate": "2025-06-23T00:05:23.0395703-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-23T00:05:23.0395703-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e2b28ea9-9a96-43ce-93dd-a89f00c13ac9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e547e28f-32a9-41c2-b34b-ca3aa3df1b19",
"CreateDate": "2025-06-23T00:05:23.0395703-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-23T00:05:23.0395703-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-23T00:05:23.0395703-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "48f81077-5064-481f-b49f-e2ea4ed741de",
"CreateDate": "2025-06-23T00:05:23.0395703-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-23T00:05:23.0395703-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}