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": "fa677940-9815-470b-80ea-8f46976796b0",
"Asset": {
"AssetId": "9483fee4-ff47-4aaa-8546-5e23c74e1cba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "62f5c0f4-31fe-40a9-a2c9-ecdb97d03c9a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed9e0460-c193-4d6f-a3c2-5b753999ea84",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7f066626-48a7-4b65-a4ce-b693e5c6c142",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-31T22:45:09.0945892-07:00",
"MeasurementValueNeededDate": "2025-07-31T22:45:09.0945892-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f02cb39b-78a2-4480-8f19-c85441dc48b1",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-31T22:45:09.0945892-07:00",
"MeasurementValueNeededDate": "2025-07-31T22:45:09.0945892-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d473972a-3523-4cc7-aaaf-6f244295d73b",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2e7793e5-5fd2-49ad-81bb-d9685fbb8f1f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "03e13c61-8506-4f0b-9c53-84437c61fea9",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-31T22:45:09.0945892-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "adfbcfc5-c45d-4d05-af10-b9198266bbf1",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-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": "a69e06e3-8677-437b-be3e-5fe4fa6a9a2a",
"Asset": {
"AssetId": "704d8997-b397-4ce2-9152-5031cb265e8a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d03dd937-5def-4f30-827c-0ace3f5935c2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7ddc0c53-5a0f-411a-abaf-5c9dd557c083",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7c23e690-7bd2-4e72-abc1-93f017df0089",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-31T22:45:09.0945892-07:00",
"MeasurementValueNeededDate": "2025-07-31T22:45:09.0945892-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e18f0174-d560-4ecd-986d-2bdeccdfaaa7",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-31T22:45:09.0945892-07:00",
"MeasurementValueNeededDate": "2025-07-31T22:45:09.0945892-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d99272d1-c776-4db8-bedb-1537bfd9fea8",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f32d4df6-58ee-4ba7-a3c6-58d7e4283761",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8cfbe9ce-038d-4ea0-a3ec-a726a72378fb",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-31T22:45:09.0945892-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "55bd7857-a1bf-48c0-9759-b43b7685ecd8",
"CreateDate": "2025-07-31T22:45:09.0945892-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T22:45:09.0945892-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}