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": "ba80824f-2bc3-4b33-a10e-1e6ffe0a1158", "Asset": { "AssetId": "01123aa2-c0cb-418a-ab18-98bc12a89fdb", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4a06108d-4835-4123-985d-7f3f4d315f01", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3d91b086-7d99-442f-9364-f504df4e0e99", "CreateDate": "2025-09-13T21:00:57.6197483-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:00:57.6197483-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "3198aa44-17dd-4001-a825-cf230d9964c5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:00:57.6197483-07:00", "MeasurementValueNeededDate": "2025-09-13T21:00:57.6197483-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8e36fd24-3f87-4969-b725-b00cedc8e16c", "CreateDate": "2025-09-13T21:00:57.6197483-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:00:57.6197483-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-13T21:00:57.6197483-07:00", "MeasurementValueNeededDate": "2025-09-13T21:00:57.6197483-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "6424794a-9dbd-4ee1-88a3-5a4d216dccf6", "CreateDate": "2025-09-13T21:00:57.6197483-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T21:00:57.6197483-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "7baea8eb-17fb-40fd-b7fd-370bc9712181", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "90b8a534-0791-46b6-93a5-7a6705d269e0", "CreateDate": "2025-09-13T21:00:57.6197483-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-13T21:00:57.6197483-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-09-13T21:00:57.6197483-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "67ec4814-6328-405e-949b-5ebd2926100a", "CreateDate": "2025-09-13T21:00:57.6197483-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-13T21:00:57.6197483-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": "9b18c2ce-44e0-407b-ba76-d232b9993070", "Asset": { "AssetId": "27631d01-7d08-4d3e-ad71-5820aaaa8995", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "76aba789-d84f-46ab-b799-c26e21d14737", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d5d56ee1-6743-4c3a-8a9f-491dc2caefeb", "CreateDate": "2025-09-13T21:00:57.635368-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:00:57.635368-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d9ef991b-3502-4815-b073-b236227761c0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:00:57.635368-07:00", "MeasurementValueNeededDate": "2025-09-13T21:00:57.635368-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b8826017-5e20-4ed6-8b71-d8870d42eb02", "CreateDate": "2025-09-13T21:00:57.635368-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:00:57.635368-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-13T21:00:57.635368-07:00", "MeasurementValueNeededDate": "2025-09-13T21:00:57.635368-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dea66b01-9d6a-4759-babd-5753ed9ff701", "CreateDate": "2025-09-13T21:00:57.635368-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T21:00:57.635368-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "68ee4bc3-6fdd-4c7d-b5e2-e54cf11b6a2e", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "549732a0-4eeb-477f-ba62-f1f2227d0724", "CreateDate": "2025-09-13T21:00:57.635368-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-13T21:00:57.635368-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-09-13T21:00:57.635368-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "62e6afe5-f98b-44d7-8631-6ae274003a5e", "CreateDate": "2025-09-13T21:00:57.635368-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-13T21:00:57.635368-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }