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": "e5b58ad3-7659-48db-9b96-a5bf71a61674",
"Asset": {
"AssetId": "6b4b584a-f3b1-492b-bf93-ee08c52cd75f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "328f0f83-07a9-4ed7-bf2a-a08b3475025d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f7627623-1218-4a22-ad86-9aba1445bc2c",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "407987a3-7827-40f4-bbfd-1d25abeab26f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-16T01:54:19.4599378-07:00",
"MeasurementValueNeededDate": "2025-09-16T01:54:19.4599378-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1453b839-a028-4e5c-86b4-9a4ad365eea8",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-16T01:54:19.4599378-07:00",
"MeasurementValueNeededDate": "2025-09-16T01:54:19.4599378-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f6566526-c04f-4a9f-9124-afdffec8f502",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "62fa9eaf-c19c-47f1-ac16-1b588ef28571",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a40c0e21-58d8-44ae-a04d-7dd3dbb90ac3",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-16T01:54:19.4599378-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a4d8292b-f18f-497e-b7e6-1447bc1ce615",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-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": "07d2964c-41f2-4455-a116-0f960006788d",
"Asset": {
"AssetId": "60ee6592-b733-47c7-adc2-bce5da52e9be",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "57c90444-30f0-4d1e-bd9a-0ae081998a14",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "24cc9ba0-473c-4061-9e49-303dc789c71e",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "91e8c797-de30-44eb-a785-b981a8429b27",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-16T01:54:19.4599378-07:00",
"MeasurementValueNeededDate": "2025-09-16T01:54:19.4599378-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "399536b2-c66a-4545-9294-3cd7610705b2",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-16T01:54:19.4599378-07:00",
"MeasurementValueNeededDate": "2025-09-16T01:54:19.4599378-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "28dfa660-9a34-4806-85a6-b60bd52b9a7c",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "c39d0af0-3986-4289-878b-fdb4deb0ad9e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a96349ac-1d81-4dbf-8937-3c8a5a06e591",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-16T01:54:19.4599378-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7eb88726-ba4f-4248-ad54-ac03cf434eda",
"CreateDate": "2025-09-16T01:54:19.4599378-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T01:54:19.4599378-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}