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": "98a09946-b13c-42a9-b009-a26431fc54af",
"Asset": {
"AssetId": "50e62d72-bf38-46b3-9aff-d50ad78d8d54",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "03f29949-23f5-4a12-a8f4-02cee824c292",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e615360a-4dce-4ae3-ae87-37ec437d30c5",
"CreateDate": "2026-11-11T22:47:18.4484789-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-11T22:47:18.4484789-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "90af7517-90d8-4c26-be46-72354d2a9453",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T22:47:18.4484789-08:00",
"MeasurementValueNeededDate": "2026-11-11T22:47:18.4484789-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ce4aa4fc-8ee8-4b87-ae5a-462da4cdab5e",
"CreateDate": "2026-11-11T22:47:18.4484789-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T22:47:18.4484789-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-11T22:47:18.4484789-08:00",
"MeasurementValueNeededDate": "2026-11-11T22:47:18.4484789-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2dc455e9-8b6a-4c35-9a33-08614cecc823",
"CreateDate": "2026-11-11T22:47:18.4484789-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-11T22:47:18.4484789-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "74d3b806-e897-4ccd-b774-a005e7a8c719",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "21dace1d-e5db-4a27-b218-7d8c7175dad9",
"CreateDate": "2026-11-11T22:47:18.4484789-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-11T22:47:18.4484789-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-11T22:47:18.4484789-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "78fef9fb-b1a6-4e46-aa79-94d56a4ba9b0",
"CreateDate": "2026-11-11T22:47:18.4484789-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-11T22:47:18.4484789-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": "750af094-a3b0-47ac-ac7c-aa4cb01ad1c7",
"Asset": {
"AssetId": "9a271f9b-c525-47fa-8ac7-66e32d473c37",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f19471bf-366e-4cd5-90ed-6b67ecfad92a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "22e30439-b0f0-463a-b996-e5fce9cf3375",
"CreateDate": "2026-11-11T22:47:18.5734781-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-11T22:47:18.5734781-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "edfafec3-8996-4a9c-b90c-bbfad870b4fb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T22:47:18.5734781-08:00",
"MeasurementValueNeededDate": "2026-11-11T22:47:18.5734781-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b65c139d-f71a-4ce2-a2a9-4b26ab940637",
"CreateDate": "2026-11-11T22:47:18.5734781-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T22:47:18.5734781-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-11T22:47:18.5734781-08:00",
"MeasurementValueNeededDate": "2026-11-11T22:47:18.5734781-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "344990aa-5450-4c87-af21-5a62c5a274d8",
"CreateDate": "2026-11-11T22:47:18.5734781-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-11T22:47:18.5734781-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "107f78d8-f094-4abd-86f5-12694efe2915",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "919a9843-be41-4311-b1e7-9592c7c5a631",
"CreateDate": "2026-11-11T22:47:18.5734781-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-11T22:47:18.5734781-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-11T22:47:18.5734781-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f67c57cf-ce45-4cf9-92a8-8020cb6ebdc1",
"CreateDate": "2026-11-11T22:47:18.5734781-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-11T22:47:18.5734781-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}