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": "70ee8eb2-23b7-4dfa-9b5f-744ee9311c15",
"Asset": {
"AssetId": "c21bc17a-2da1-445e-a7ee-76e1d55ff5ae",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1c827d09-b043-4aca-a235-253184bcc11a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1967a160-a879-4e72-8ea6-9c803c9d78ce",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "50e1694e-998c-4c05-865c-821eff526a66",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-16T23:37:53.5641878-08:00",
"MeasurementValueNeededDate": "2025-11-16T23:37:53.5641878-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "59e97b04-55de-4ef0-8c56-88be1c70c4ea",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-16T23:37:53.5641878-08:00",
"MeasurementValueNeededDate": "2025-11-16T23:37:53.5641878-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "78a22637-61db-4854-a2f8-34cb41e7de69",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f945828d-31f6-4e50-bc0d-a184a13c1e83",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "00f07abb-54e0-4623-9820-151ddc08fed4",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-16T23:37:53.5641878-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "53a94798-4596-4418-9ee2-979d06ea583c",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-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": "d71974aa-b48f-4304-a049-cfbeac924cc9",
"Asset": {
"AssetId": "1a2d3348-e8a0-4013-8dc2-658f604c583e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3690276c-75af-4b08-abf5-2b6a743d4ff6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "524c191c-3493-4d6a-9980-47ac40e777d5",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f37b9da4-b03f-4777-b31f-b1e65f5d7667",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-16T23:37:53.5641878-08:00",
"MeasurementValueNeededDate": "2025-11-16T23:37:53.5641878-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "845ed2ad-5c76-40a3-bfd5-45ff0f368876",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-16T23:37:53.5641878-08:00",
"MeasurementValueNeededDate": "2025-11-16T23:37:53.5641878-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7895bc89-b39b-46c7-a629-73c9b6c91344",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a82b384f-1f09-47fb-8400-3dddb52f4513",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ed6c6256-d159-4e81-8035-8f90252a4e06",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-16T23:37:53.5641878-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "86322972-4e48-48e8-a928-dbcc36d069d5",
"CreateDate": "2025-11-16T23:37:53.5641878-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-16T23:37:53.5641878-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}