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": "016c3560-b18d-435c-b726-130658974a3b",
"Asset": {
"AssetId": "dbbc222a-dc05-40ae-9e05-c9f96f916fd0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c6dc598c-e387-4c2a-9220-807684a27f47",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "19ff9c30-62f7-47cc-8d24-eacbc6956bcc",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3b54e890-dcf4-4d09-96ee-3de44c2ed5ad",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:38:57.9324669-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:38:57.9324669-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "acef78db-684f-45f0-a8b0-fd9ddc8ed863",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-28T09:38:57.9324669-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:38:57.9324669-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fcb82749-7f9d-4e91-ad40-4d9fa54f8ffb",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f1802183-8da2-4705-9acd-e0c8764f8392",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f4d35fdf-3ce5-40ef-957e-0c06923ebefc",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-28T09:38:57.9324669-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d29f69cf-8913-43ce-b9fb-fee2d669005f",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-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": "6f3d5aa7-0eca-4770-88d5-f2e24f1b895d",
"Asset": {
"AssetId": "f1f8f715-4188-4307-b7c0-5578787703b1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "353ebb4c-5a4d-44a1-9789-4ee33f14fa31",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "901b2b50-041d-4c6d-b159-460305144fd0",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "97d94301-af2d-49a1-9e49-ecda519deeb1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:38:57.9324669-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:38:57.9324669-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2eee5ff4-683c-421f-850d-ea571516dacf",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-28T09:38:57.9324669-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:38:57.9324669-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c4365d38-e843-4895-ad07-9b93a2c33511",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "c26aa985-a372-406c-bcca-48af72d22572",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c48a4792-8df7-4f4c-aae6-f25338b0a79e",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-28T09:38:57.9324669-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9afaba1b-7bb6-4fa5-b2a2-586bcafd1f44",
"CreateDate": "2026-06-28T09:38:57.9324669-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:38:57.9324669-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}