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": "480c1306-d268-4136-886f-5a50272ad8f0",
"Asset": {
"AssetId": "830bf467-b1b5-4d05-b597-9ff74ac70366",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "43034d63-76b0-4411-9193-17b83aa52b25",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "65bd852f-4678-4f90-9d3c-df04ca7e3f83",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9b374db8-a0ec-4682-9997-d6fa333b66bb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-24T10:00:10.6696384-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:00:10.6696384-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4f6abfa7-54dd-4fb2-971e-8d456d995d5b",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-24T10:00:10.6696384-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:00:10.6696384-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bc952fc7-0026-4565-a725-d10cbab23c2d",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "6717d1d5-d285-4f01-843e-689bb9b21587",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "76d3661f-fed9-4cc4-99fa-1c06e21cbd7d",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-24T10:00:10.6696384-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "92e94e8e-604f-4377-80e5-c6aca85e17af",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-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": "96932e0b-62cc-44e8-b66c-2ca1641155c9",
"Asset": {
"AssetId": "3435c347-2d32-4bd9-8017-a8601e965247",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1c954199-1c65-4bb3-9f82-6b9d088c2103",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b04c1134-9159-43ea-b07b-2ab2b70530f8",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5cc20dd4-0f85-441b-ac46-1c61662ef164",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-24T10:00:10.6696384-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:00:10.6696384-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1bd9d8f0-785f-4f68-a310-f9153c3b3ca8",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-24T10:00:10.6696384-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:00:10.6696384-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "db948f24-e14e-48c1-8535-7170360abae3",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8f6e0391-8ff8-4f83-8d4c-6ee9d6910a9c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "75ed1203-6b38-455f-82ab-ff5bd0050f4e",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-24T10:00:10.6696384-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ed580619-790c-4ced-8dfe-69d56f5fff70",
"CreateDate": "2025-08-24T10:00:10.6696384-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:00:10.6696384-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}