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": "4bd4ddb8-5392-429c-a214-2190ae9ddebb",
"Asset": {
"AssetId": "6f6c22bb-32a0-42c2-bf3d-124efb458bc4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2f41433e-3243-46f2-9d2e-1de2639c6b9c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c32599e7-3d00-4f2b-87dd-353962a451bb",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e2dac720-e584-40db-bfab-feb887dfa473",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-31T00:31:56.7617196-07:00",
"MeasurementValueNeededDate": "2025-10-31T00:31:56.7617196-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "64eb813e-fbf9-4fc5-9f65-e7637b0cfb7f",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-31T00:31:56.7617196-07:00",
"MeasurementValueNeededDate": "2025-10-31T00:31:56.7617196-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e48a3b3c-c519-4b8a-bc2d-27b1c9c21e57",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "557c18e7-81a9-4835-861a-6c78583783aa",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fc4cbc3d-dacf-4114-bf1c-3c8e6418a923",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-31T00:31:56.7617196-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9bd3108a-3549-4672-b36c-cc376dd9ff85",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-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": "cbd0862d-4cd1-43b4-aa29-1e8b2a0ddba7",
"Asset": {
"AssetId": "7b959736-1931-4ff1-8b56-3358226fe2f3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5e99fca2-9726-4a66-bf40-3b2c04d63c24",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "46da7b25-a49d-4d40-aa16-d9e12616658f",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "34dff3cf-c642-4cb8-9792-a9018d359609",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-31T00:31:56.7617196-07:00",
"MeasurementValueNeededDate": "2025-10-31T00:31:56.7617196-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5bda138b-3b5d-45b7-8415-a8418d0a92ee",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-31T00:31:56.7617196-07:00",
"MeasurementValueNeededDate": "2025-10-31T00:31:56.7617196-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0737b87f-ec82-4cea-b798-de6aa4e18747",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "bbef15dc-1eec-425d-a034-3a2c861ea914",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1fd9321d-aff2-43fd-894b-19a4c1ab8640",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-31T00:31:56.7617196-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "94a9f36c-f3b9-44fe-ade1-99e62193a5cb",
"CreateDate": "2025-10-31T00:31:56.7617196-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-31T00:31:56.7617196-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}