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": "e20804ef-98ff-4794-8ff6-62f4bb0a1b92",
"Asset": {
"AssetId": "34347cf0-2d89-4368-8dce-acd564678c75",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "602eeab2-a9d5-4b14-b4c8-91c94faf035d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "78331145-fa5d-4730-9dd0-c6d35b8e0495",
"CreateDate": "2025-07-18T04:11:15.297356-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T04:11:15.297356-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b82954f1-213c-4e68-bd36-ef5c7767248f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-18T04:11:15.297356-07:00",
"MeasurementValueNeededDate": "2025-07-18T04:11:15.297356-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cb06c9c3-5eb9-4604-99a5-0348a8a36e82",
"CreateDate": "2025-07-18T04:11:15.297356-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T04:11:15.297356-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-18T04:11:15.297356-07:00",
"MeasurementValueNeededDate": "2025-07-18T04:11:15.297356-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0a6d8456-2f6b-4415-9c0c-6279744719cb",
"CreateDate": "2025-07-18T04:11:15.297356-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T04:11:15.297356-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "308c9faa-4aa0-4514-8a02-d7aca5684ad1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d26f6f0e-72a0-4aeb-b92d-8dd986d5ef7a",
"CreateDate": "2025-07-18T04:11:15.297356-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-18T04:11:15.297356-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-18T04:11:15.297356-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9ec2fcaa-6849-4be3-b83b-401b4b9a8b9c",
"CreateDate": "2025-07-18T04:11:15.297356-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-18T04:11:15.297356-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": "fbb18b30-f12c-45fa-ba70-9afbf8c2ce71",
"Asset": {
"AssetId": "3728cdf5-20c6-423d-8ac5-341fbc5e61ae",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5942633e-aa3a-43de-8f8d-78850885b5b0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "eb4ae840-06bb-4b80-abba-d26e1cea8e34",
"CreateDate": "2025-07-18T04:11:15.3128723-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T04:11:15.3128723-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "28adde64-12b9-4a63-837f-8f9be78f9a49",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-18T04:11:15.3128723-07:00",
"MeasurementValueNeededDate": "2025-07-18T04:11:15.3128723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "624d8ef9-f0a2-4dff-9891-655d775411d1",
"CreateDate": "2025-07-18T04:11:15.3128723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T04:11:15.3128723-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-18T04:11:15.3128723-07:00",
"MeasurementValueNeededDate": "2025-07-18T04:11:15.3128723-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ca5ff73f-9a45-40ec-9789-3d29495f35c4",
"CreateDate": "2025-07-18T04:11:15.3128723-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T04:11:15.3128723-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "036eb801-53aa-4209-872c-5927d28c10cc",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a8d163b2-cc33-4405-a5d6-91c2d7225a81",
"CreateDate": "2025-07-18T04:11:15.3128723-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-18T04:11:15.3128723-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-18T04:11:15.3128723-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "df64a0a0-dcf4-4856-8f36-4a44c74e4799",
"CreateDate": "2025-07-18T04:11:15.3128723-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-18T04:11:15.3128723-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}