VOOZH about

URL: https://developer.mescius.com/componentone/demos/aspnet/webapiexplorer

⇱ Home

APIs that give you full control.

Generate Excel files, BarCodes, Reports, export HTML5 data management or visualization controls to the format of your choice. With these powerful Web APIs, you can generate excel files from different data sources, manipulate and merge excel files, create barcodes on the fly, analyze huge datasets and SSAS Cubes, render reports and PDF. The possibilities are limited only by the developer’s imagination.

👁 Image
  Excel
GET
/api/excel
Generate from dataset\collection

Description

Generate excel file from dataset\collection configured on server.

Parameters

Request Url

Show Json Data by FlexGrid

Show XML Data

Response Schema


 
 

 

 

 

 

 

 GET
 

 

 /api/excel
 

 

 Generate from XML
 

 

 

 

 

 

 

 
Description

 Generate excel file from XML file available in storage.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Show Json Data by FlexGrid

 
 
Show XML Data

 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 GET
 

 

 /api/excel
 

 

 Convert between different formats
 

 

 

 

 

 

 

 
Description

 Convert excel file available in storage into different format.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Show Json Data by FlexGrid

 
 
Show XML Data

 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 POST
 

 

 /api/excel
 

 

 Generate from XML
 

 

 

 

 

 

 

 
Description

 Generate excel file from XML file posted from client.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Show Json Data by FlexGrid

 
 
Show XML Data

 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 POST
 

 

 /api/excel
 

 

 Generate from JSON
 

 

 

 

 

 

 

 
Description

 Generate excel file from JSON data posted from client.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Show Json Data by FlexGrid

 
 
Show XML Data

 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 POST
 

 

 /api/excel
 

 

 Convert between different formats
 

 

 

 

 

 

 

 
Description

 Convert excel file into different format.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Show Json Data by FlexGrid

 
 
Show XML Data

 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
 

 

 

 

 GET
 

 

 /api/excel/merge
 

 

 

 

 

 

 

 
Description

 Merge multiple excel files available in file storage.
 

 

 

 

 

 

 
Parameters

 
 

 

 

 
 
 
 

 
 
 

 
 
 
 

 

 





 
Request Url

 

 
 

 

 
Show Json Data by FlexGrid

 
 
Show XML Data

 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 POST
 

 

 /api/excel/merge
 

 

 

 

 

 

 

 
Description

 Merge multiple files posted from client.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Show Json Data by FlexGrid

 
 
Show XML Data

 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
 

 

 

 

 GET
 

 

 /api/excel/{excel path}/split
 

 

 

 

 

 

 

 
Description

 Split an excel file from storage to multiple excel files and save it into storage.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
 

 

 

 

 GET
 

 

 /api/excel/{excel path}/{sheet name}/find
 

 

 

 

 

 

 

 
Description

 Find text in excel, return all matches info.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 GET
 

 

 /api/excel/{excel path}/{sheet name}/replace
 

 

 

 

 

 

 

 
Description

 Replace text in excel.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
 

 

 

 

 POST
 

 

 /api/excel/{excel path}/{sheet name}/rows/{row index}
 

 

 

 

 

 

 

 
Description

 Add rows.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 PUT
 

 

 /api/excel/{excel path}/{sheet name}/rows/{row indexes}
 

 

 

 

 

 

 

 
Description

 Update rows, you can use this API to hide/unhide group/ungroup rows.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 DELETE
 

 

 /api/excel/{excel path}/{sheet name}/rows/{row indexes}
 

 

 

 

 

 

 

 
Description

 Delete rows.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
 

 

 

 

 POST
 

 

 /api/excel/{excel path}/{sheet name}/columns/{column index}
 

 

 

 

 

 

 

 
Description

 Add columns.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 PUT
 

 

 /api/excel/{excel path}/{sheet name}/columns/{column indexes}
 

 

 

 

 

 

 

 
Description

 Update columns, you can use this API to hide/unhide group/ungroup columns.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 DELETE
 

 

 /api/excel/{excel path}/{sheet name}/columns/{column indexes}
 

 

 

 

 

 

 

 
Description

 Delete columns.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 

 

 

 

 

 

 

 

 
 
👁 Image
  Storage

 
 

 

 

 

 

 

 

 

 
 

 

 
 

 

 
 

 

 

 

 POST
 

 

 /api/storage/{path}
 

 

 

 

 

 

 

 
Description

 Upload a file to storage.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 View Files: 
 







 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 DELETE
 

 

 /api/storage/{path}
 

 

 

 

 

 

 

 
Description

 Delete a file from storage.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Request Url

 

 
 

 

 
Response Data

 

 
 

 







 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 GET
 

 

 /api/storage/List/{path}
 

 

 

 

 

 

 

 
Description

 List all files, folders from target folder.
 

 

 

 

 

	

		
Parameters

		
	

	




	
Request Url

	

		
 

	

	
Response Data

	

		
 

	







 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 

 

 

 

 

 

 

 

 

 

 
 
👁 Image
  Report

 
 

 

 

 

 

 

 

 

 
 

 

 

 

 GET
 

 

 /api/report/{folder path}
 

 

 

 

 

 

 

 
Description

 Gets the report list in the specified folder path.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 
 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$report
 

 

 

 

 

 

 

 
Description

 Gets the info of the specified report.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$report/pagesettings
 

 

 

 

 

 

 

 
Description

 Gets the default page settings defined in the specified report.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$report/parameters
 

 

 

 

 

 

 

 
Description

 Get all the parameters defined in the report.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$report/parameters/{parameter name}
 

 

 

 

 

 

 

 
Description

 Get specified parameter defined in the report.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$report/supportedformats
 

 

 

 

 

 

 

 
Description

 Get all the supported export formats.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$report/supportedformats/{supported format}
 

 

 

 

 

 

 

 
Description

 Get specified supported format.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$report/export
 

 

 

 

 

 

 

 
Description

 Render and export the report to the specified export filter with options and the specified page settings or/and parameters.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 
 

 

 

 

 

 

 POST
 

 

 /api/report/{folder path}/{report name}/$report/export
 

 

 

 

 

 

 

 
Description

 Render and export the report to the specified export filter with options and the specified page settings or/and parameters.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 
 

 

 

 

 
 

 

 

 

 POST
 

 

 /api/report/{folder path}/{report name}/$instances
 

 

 

 

 

 

 

 
Description

 Creates new report instance from the specified report.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}
 

 

 

 

 

 

 

 
Description

 Gets the info of the report instance with the specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 POST
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/render
 

 

 

 

 

 

 

 
Description

 Renders the report instance with the specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 
Response Messages

 
 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/status
 

 

 

 

 

 

 

 
Description

 Gets the status of the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/parameters
 

 

 

 

 

 

 

 
Description

 Gets the parameters in the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 PUT
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/parameters
 

 

 

 

 

 

 

 
Description

 Updates all parameter values in the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 PATCH
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/parameters
 

 

 

 

 

 

 

 
Description

 Updates specified parameter values in the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName}
 

 

 

 

 

 

 

 
Description

 Gets the parameter with specified name in the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 PUT
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName}
 

 

 

 

 

 

 

 
Description

 Updates the value of parameter with specified name in the report instance with specified instance if.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings
 

 

 

 

 

 

 

 
Description

 Gets the current page settings in the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 PUT
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings
 

 

 

 

 

 

 

 
Description

 Updates all page settings properties in the report instance with specified instance id.
 

 

 

 

 

 

 
PageSettings

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 PATCH
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings
 

 

 

 

 

 

 

 
Description

 Updates the specified page settings properties in the report instancce with specified instance id.
 

 

 

 

 

 

 
PageSettings

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/supportedformats
 

 

 

 

 

 

 

 
Description

 Get all the supported export formats.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/supportedformats/{format name}
 

 

 

 

 

 

 

 
Description

 Gets the export format with specified name supported by the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/features
 

 

 

 

 

 

 

 
Description

 Gets the features supported by the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/export
 

 

 

 

 

 

 

 
Description

 Exports the report instance with specified instance id into report filter with options.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 
 

 

 

 

 

 

 POST
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/export
 

 

 

 

 

 

 

 
Description

 Exports the report instance with specified instance id into report filter with options.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/outlines
 

 

 

 

 

 

 

 
Description

 Gets all outlines in the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/bookmarks/{bookmark name}
 

 

 

 

 

 

 

 
Description

 Gets the bookmark with specified name in the report instance with specified instance id.
 

 

 

 

 

 

 
Parameters

 

 
 

 (Please render report first)
 

 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/search
 

 

 

 

 

 

 

 
Description

 Get the search result of the report with specified instance id, please ensure that the report has been rendered.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 POST
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}/stop
 

 

 

 

 

 

 

 
Description

 Stop the current rendering.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 DELETE
 

 

 /api/report/{folder path}/{report name}/$instances/{instance id}
 

 

 

 

 

 

 

 
Description

 Delete the instance.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 

 

 

 

 

 
 

 

 

 
 
👁 Image
  Barcode

 
 

 

 

 

 

 

 

 

 
 

 

 

 

 GET
 

 

 /api/barcode
 

 

 

 

 

 

 

 
Description

 API to generate barcode
 

 

 

 

 

 

 
Parameters

 
 

 

 

 
Bacis Settings

 
 
 
 
 
 
 
 
 
 

 

 
QRCode Settings

 
 
 
 
 
 
 

 

 
PDF417 Settings

 
 
 
 
 

 

 
Code49 Settings

 
 
 

 

 
RssExpandedStacked Settings

 
 

 

 
MicroPDF417 Settings

 
 
 
 
 
 

 

 
Code25intlv Settings

 
 
 
 

 

 
GS1Composite Settings

 
 
 

 

 
Ean128Fnc1 Settings

 
 
 
 

 

 
DataMatrix Settings

 
 
 
 
 
 
 
 

 





 
Request Url

 

 
 

 


 
Barcode

 
 
Your browser does not support TIFF images, you can click  to download it.




 

 

 

 

 

 

 

 

 

 

 

 

 

 
 
👁 Image
  DataEngine

 
 

 

 

 

 

 

 

 

 
 

 

 
 

 

 
 

 

 
 

 

 

 

 GET
 

 

 /api/dataengine/{datasource}/fields
 

 

 

 

 

 

 

 
Description

 Gets all the fields in the data.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/dataengine/{datasource}?[skip=n&top=m]
 

 

 

 

 

 

 

 
Description

 Get the raw data. It is not supported when connecting cube data.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 POST
 

 

 /api/dataengine/{datasource}
 

 

 

 

 

 

 

 
Description

 Get a list of objects in the raw data source that define the content of a specific cell in the output table. It is not supported when connecting cube data.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 POST
 

 

 /api/dataengine/{datasource}/fields/{fieldname}/uniquevalues
 

 

 

 

 

 

 

 
Description

 Get the unique values of a field. It is not supported when connecting cube data.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 POST
 

 

 /api/dataengine/{datasource}/analyses
 

 

 

 

 

 

 

 
Description

 Analyze the data from the specified data source.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/dataengine/{datasource}/analyses/{token}/status
 

 

 

 

 

 

 

 
Description

 Get the status of the analysis.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/dataengine/{datasource}/analyses/{token}/result
 

 

 

 

 

 

 

 
Description

 Get the analysis result data.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/dataengine/{datasource}/analyses/{token}
 

 

 

 

 

 

 

 
Description

 Get the analysis information.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 DELETE
 

 

 /api/dataengine/{datasource}/analyses/{token}
 

 

 

 

 

 

 

 
Description

 Clear the analysis.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 

 

 

 

 

 

 

 

 
 
👁 Image
  Pdf

 
 

 

 

 

 

 

 

 

 
 

 

 

 

 GET
 

 

 /api/pdf/{pdf path}/$pdf
 

 

 

 

 

 

 

 
Description

 Get the execution info of the specified pdf.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 





 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/pdf/{pdf path}/$pdf/status
 

 

 

 

 

 

 

 
Description

 Get the status of the specified pdf.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 





 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/pdf/{pdf path}/$pdf/supportedformats
 

 

 

 

 

 

 

 
Description

 Get all the supported export formats.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 





 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/pdf/{pdf path}/$pdf/features
 

 

 

 

 

 

 

 
Description

 Get all the supported features.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 





 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/pdf/{pdf path}/$pdf/export
 

 

 

 

 

 

 

 
Description

 Export the pdf to the specified format with options.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 





 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 
 

 

 

 

 

 

 POST
 

 

 /api/pdf/{pdf path}/$pdf/export
 

 

 

 

 

 

 

 
Description

 Export the pdf to the specified format with options in body.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 





 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages

 
 
 
 
 

 

 

 

 

 

 GET
 

 

 /api/pdf/{pdf path}/$pdf/search
 

 

 

 

 

 

 

 
Description

 Gets the rearch result in the pdf document source instance with specified path.
 

 

 

 

 

 

 
Parameters

 
 

 




 
Headers

 

 
 

 

 
Response Data

 

 
 

 






 

 

 

 

 
Response Schema

 

 

 
 

 

 

 

 
Response Messages