ComponentOne
Web API Explorer ASP.NET Web API Explorer
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.

Description

Generate excel file from dataset\collection configured on server.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema


                                                                    
                                                                

Description

Generate excel file from XML file available in storage.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema


                                                                    
                                                                

Description

Convert excel file available in storage into different format.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema


                                                                    
                                                                

Description

Generate excel file from XML file posted from client.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema


                                                                    
                                                                

Description

Generate excel file from JSON data posted from client.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema


                                                                    
                                                                

Description

Convert excel file into different format.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema


                                                                    
                                                                

Description

Merge multiple excel files available in file storage.

Parameters


Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema


                                                                    
                                                                

Description

Merge multiple files posted from client.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema


                                                                    
                                                                

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


                                                                    
                                                                

Description

Find text in excel, return all matches info.

Parameters

Request Url

        

Response Data

        

Response Schema


                                                                    
                                                                

Description

Replace text in excel.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema


                                                                    
                                                                

Description

Add rows.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema


                                                                    
                                                                

Description

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

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema


                                                                    
                                                                

Description

Delete rows.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema


                                                                    
                                                                

Description

Add columns.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema


                                                                    
                                                                

Description

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

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema


                                                                    
                                                                

Description

Delete columns.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema


                                                                    
                                                                

Description

Upload a file to storage.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema


                                                                    
                                                                

Description

Gets the report list in the specified folder path.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Gets the info of the specified report.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Gets the default page settings defined in the specified report.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get all the parameters defined in the report.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get specified parameter defined in the report.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get all the supported export formats.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get specified supported format.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

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

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

Description

Creates new report instance from the specified report.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Renders the report instance with the specified instance id.

Parameters

Headers

        

Response Data

        

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

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

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

PageSettings

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

PageSettings

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get all the supported export formats.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

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

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

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

Description

Stop the current rendering.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Delete the instance.

Parameters

Headers

        

Response Data

        

Response Messages

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

Description

Gets all the fields in the data.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

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

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Analyze the data from the specified data source.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get the status of the analysis.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get the analysis result data.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get the analysis information.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Clear the analysis.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get the execution info of the specified pdf.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get the status of the specified pdf.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get all the supported export formats.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Get all the supported features.

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages

Description

Export the pdf to the specified format with options.

Parameters

Headers

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Schema


                                                                    
                                                                

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema


                                                                    
                                                                

Response Messages