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": "46898b38-cd0c-4a0c-9722-9c9a47d38e56",
"Asset": {
"AssetId": "848aadfe-6768-4715-8e76-31bcc537b985",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5af9f0e9-0f0e-4e38-9ddc-2ebc9a4a8d77",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dd65d750-85ec-4781-9b72-8f7f7ff9f564",
"CreateDate": "2025-12-21T04:46:34.6118292-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-21T04:46:34.6118292-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "16dd198b-95f5-475a-865c-629147c10d6e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:46:34.6118292-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:46:34.6118292-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6fd684fd-b597-47b3-9164-80bcb2fe466e",
"CreateDate": "2025-12-21T04:46:34.6118292-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:46:34.6118292-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-21T04:46:34.6118292-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:46:34.6118292-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "79a1501a-1a79-4027-8bf0-36b2e981abe7",
"CreateDate": "2025-12-21T04:46:34.6118292-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-21T04:46:34.6118292-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "0ebc9494-a724-4238-b3ab-30a9367bfe7b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8a6cb6c1-4082-4351-ac33-cdcc0b426a1f",
"CreateDate": "2025-12-21T04:46:34.6118292-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:46:34.6118292-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-21T04:46:34.6118292-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "48674f6f-a527-4b0c-a872-179147e1a99e",
"CreateDate": "2025-12-21T04:46:34.6118292-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:46:34.6118292-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": "98223425-395a-4313-bdcc-fd039a97f95d",
"Asset": {
"AssetId": "a7749405-0e94-4b6f-8f6e-ec5f1e22895c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "526acb59-afd3-4c2c-bd1f-c91bdab69d17",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3c11d657-8370-4cd8-8efe-cd98e7cb6b98",
"CreateDate": "2025-12-21T04:46:34.9087054-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-21T04:46:34.9087054-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "03677672-e525-4b6c-ba02-670a3105cced",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:46:34.9087054-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:46:34.9087054-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1317f974-7637-4b17-83eb-6e2268711334",
"CreateDate": "2025-12-21T04:46:34.9087054-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:46:34.9087054-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-21T04:46:34.9087054-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:46:34.9087054-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "081b40ef-f414-4b9b-899a-d65549588bf5",
"CreateDate": "2025-12-21T04:46:34.9087054-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-21T04:46:34.9087054-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d7ab79cd-1117-49f8-86bc-d085c0789fa9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2828e3c6-a95a-4ba9-ba28-d0ec8aadfa18",
"CreateDate": "2025-12-21T04:46:34.9087054-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:46:34.9087054-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-21T04:46:34.9087054-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "06941226-d600-48b6-bb76-609d1ddd99cd",
"CreateDate": "2025-12-21T04:46:34.9087054-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:46:34.9087054-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}