POST Notes
Creates a new note.
Request Information
URI Parameters
None.
Body Parameters
The note to create. NoteId should not be filled in.
NoteName | 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": "7a1d9d6a-f543-4d92-83e4-f58c04d50f6c", "Asset": { "AssetId": "5f6e131a-0587-44cf-8f92-07fd6d5c1630", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "442a5e77-d10b-47b5-a3ad-ef7010a428bc", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bf5045a0-75dd-4545-add6-9ea377b6368a", "CreateDate": "2025-05-08T22:25:13.0512197-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T22:25:13.0512197-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "8f059752-2b1e-42d1-9d14-c56577fe301d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T22:25:13.0512197-07:00", "MeasurementValueNeededDate": "2025-05-08T22:25:13.0512197-07:00", "SourceSystemId": "sample string 3", "CompanyId": "15e0e779-09c9-437e-a807-dad52ab43530", "CreateDate": "2025-05-08T22:25:13.0512197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T22:25:13.0512197-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-08T22:25:13.0512197-07:00", "MeasurementValueNeededDate": "2025-05-08T22:25:13.0512197-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a464908d-069a-457f-97cc-512cfcd3d2e5", "CreateDate": "2025-05-08T22:25:13.0512197-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T22:25:13.0512197-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "fe7ec181-e975-40e4-831a-4785610ccfd3", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "f0555cae-724c-467d-b223-75dd6928639c", "CreateDate": "2025-05-08T22:25:13.0512197-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T22:25:13.0512197-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-05-08T22:25:13.0512197-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "7ddb42db-fde6-4dea-942d-daed04cc7438", "CreateDate": "2025-05-08T22:25:13.0512197-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T22:25:13.0512197-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": "31d32a1a-2ed4-4733-93e3-b126359562a6", "Asset": { "AssetId": "ac0f4651-efd1-409f-815e-c5d31bb7ab49", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "afa3ac43-1885-4e4c-8a21-de0571606977", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1130ed3c-3a5e-4f4d-9d22-f9bc7a0b3158", "CreateDate": "2025-05-08T22:25:13.4575347-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T22:25:13.4575347-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "ad8621fa-63b1-4ba7-b657-61b25775877a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T22:25:13.4575347-07:00", "MeasurementValueNeededDate": "2025-05-08T22:25:13.4575347-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bfe77dff-7b9b-48ff-b2b4-14e9503e710c", "CreateDate": "2025-05-08T22:25:13.4575347-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T22:25:13.4575347-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-08T22:25:13.4575347-07:00", "MeasurementValueNeededDate": "2025-05-08T22:25:13.4575347-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f5332ea5-ac29-4699-9c4a-c02a128c4718", "CreateDate": "2025-05-08T22:25:13.4575347-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T22:25:13.4575347-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "eaadb078-5d01-4988-8606-54db57d1b60e", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "8f810d10-a35c-4c36-8cd2-b0dbfddd8a6f", "CreateDate": "2025-05-08T22:25:13.4575347-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T22:25:13.4575347-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-05-08T22:25:13.4575347-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "6032d989-91a3-439b-9c28-6dabe716fc2d", "CreateDate": "2025-05-08T22:25:13.4575347-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T22:25:13.4575347-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }