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": "b9a25286-2c37-46a6-b1ad-bc7c4509d223",
"Asset": {
"AssetId": "170da7be-c8a2-42a4-aaa9-a7a181804037",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "56521912-e93d-4eae-b35b-c7f77013157f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fdcf9593-c09d-438d-89a1-209e60e10b1f",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0658f1d4-1153-4eba-9c7f-9899013ca1f6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-13T02:58:41.7088886-08:00",
"MeasurementValueNeededDate": "2025-12-13T02:58:41.7088886-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "aae078b1-3778-4de4-a8ba-9b41af6d78c5",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-13T02:58:41.7088886-08:00",
"MeasurementValueNeededDate": "2025-12-13T02:58:41.7088886-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "437298a5-02f5-4107-9edf-f931ba834f8a",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "c5407a96-00ae-4913-b1c7-535153f3f820",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2b152161-66c1-47d7-af56-65cb82730041",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-13T02:58:41.7088886-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f0ba366e-94fb-49b3-8758-07bf25448c97",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-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": "c2a91110-43c9-4622-8e17-43418d729267",
"Asset": {
"AssetId": "3025f3cb-4301-428b-8643-cbdea700f324",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c6f6dff0-e5ae-431e-808a-3f3bf414ddaa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "94a81427-2324-49aa-aeb6-43128a505c4b",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "31c3a80b-f0cf-4760-b4f3-fc530828f78b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-13T02:58:41.7088886-08:00",
"MeasurementValueNeededDate": "2025-12-13T02:58:41.7088886-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f1330746-61de-464f-99ef-f541a3b05e78",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-13T02:58:41.7088886-08:00",
"MeasurementValueNeededDate": "2025-12-13T02:58:41.7088886-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e83349cd-8a5d-47f6-b207-e978a5ad961f",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "883f175b-4ea0-4322-b173-6ed9ea602add",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bc06f465-5fb9-4a7b-a89d-4f9f17a800fc",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-13T02:58:41.7088886-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1c5e5e21-2244-44a2-85b9-25c1e0242899",
"CreateDate": "2025-12-13T02:58:41.7088886-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-13T02:58:41.7088886-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}