ComponentOne
Web API Explorer ASP.NET Web API Explorer
APIs that give you full control.

Generate Excel files from JSON\XML\Collections, create BarCodes, export HTML5 data management controls to the format of your choice, perform CRUD operation on cloud storage. With these powerful Web APIs, you can generate excel files from different data sources, split, manipulate and merge excel files, create barcodes on the fly, analyse huge datasets, store, retrieve, delete files on the cloud. 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

{
  "creator": "",
  "created": "",
  "lastModifiedBy": "",
  "modified": "",
  "activeWorksheet": "",
  "styles": [
    {
       "formatCode": "",
      "font": {
        "family": "",
        "size": "",
        "bold": "",
        "italic": "",
        "underline": "",
        "strikethrough": "",
         "color": ""
      },
      "hAlign": "",
      "vAlign": "",
      "indent": "",
      "textRotation": "",
      "textDirection": "",
      "border": {
        "top": {
           "color": "",
          "type": ""
          },
        "bottom": { },
        "left": { },
        "right": { }
      },
      "fill": {
        "color": "",
        "pattern": ""
         },
      "wrapText": "",
      "shrinkToFit": "",
      "locked": ""
    }
  ],
  "sheets": [
    {
      "name": "",
      "frozenPane": "",
      "cols": [
         {
        "width": "",
        "visible": "",
        "style": { },
        "autoWidth": ""
        }
      ],
      "rows": [
        {
          "height": "",
          "visible": "",
           "groupLevel": "",
          "style": { },
          "cells": [
            {
            "value": "",
            "formula": "",
            "style": "0",
            "colSpan": "",
             "rowSpan": ""
            }
          ]
        }
      ]
    }
  ]
}

Description

Generate excel file from XML file available in storage.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema

{
  "creator": "",
  "created": "",
  "lastModifiedBy": "",
  "modified": "",
  "activeWorksheet": "",
  "styles": [
    {
       "formatCode": "",
      "font": {
        "family": "",
        "size": "",
        "bold": "",
        "italic": "",
        "underline": "",
        "strikethrough": "",
         "color": ""
      },
      "hAlign": "",
      "vAlign": "",
      "indent": "",
      "textRotation": "",
      "textDirection": "",
      "border": {
        "top": {
           "color": "",
          "type": ""
          },
        "bottom": { },
        "left": { },
        "right": { }
      },
      "fill": {
        "color": "",
        "pattern": ""
         },
      "wrapText": "",
      "shrinkToFit": "",
      "locked": ""
    }
  ],
  "sheets": [
    {
      "name": "",
      "frozenPane": "",
      "cols": [
         {
        "width": "",
        "visible": "",
        "style": { },
        "autoWidth": ""
        }
      ],
      "rows": [
        {
          "height": "",
          "visible": "",
           "groupLevel": "",
          "style": { },
          "cells": [
            {
            "value": "",
            "formula": "",
            "style": "0",
            "colSpan": "",
             "rowSpan": ""
            }
          ]
        }
      ]
    }
  ]
}

Description

Convert excel file available in storage into different format.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema

{
  "creator": "",
  "created": "",
  "lastModifiedBy": "",
  "modified": "",
  "activeWorksheet": "",
  "styles": [
    {
       "formatCode": "",
      "font": {
        "family": "",
        "size": "",
        "bold": "",
        "italic": "",
        "underline": "",
        "strikethrough": "",
         "color": ""
      },
      "hAlign": "",
      "vAlign": "",
      "indent": "",
      "textRotation": "",
      "textDirection": "",
      "border": {
        "top": {
           "color": "",
          "type": ""
          },
        "bottom": { },
        "left": { },
        "right": { }
      },
      "fill": {
        "color": "",
        "pattern": ""
         },
      "wrapText": "",
      "shrinkToFit": "",
      "locked": ""
    }
  ],
  "sheets": [
    {
      "name": "",
      "frozenPane": "",
      "cols": [
         {
        "width": "",
        "visible": "",
        "style": { },
        "autoWidth": ""
        }
      ],
      "rows": [
        {
          "height": "",
          "visible": "",
           "groupLevel": "",
          "style": { },
          "cells": [
            {
            "value": "",
            "formula": "",
            "style": "0",
            "colSpan": "",
             "rowSpan": ""
            }
          ]
        }
      ]
    }
  ]
}

Description

Generate excel file from XML file posted from client.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema

{
  "creator": "",
  "created": "",
  "lastModifiedBy": "",
  "modified": "",
  "activeWorksheet": "",
  "styles": [
    {
       "formatCode": "",
      "font": {
        "family": "",
        "size": "",
        "bold": "",
        "italic": "",
        "underline": "",
        "strikethrough": "",
         "color": ""
      },
      "hAlign": "",
      "vAlign": "",
      "indent": "",
      "textRotation": "",
      "textDirection": "",
      "border": {
        "top": {
           "color": "",
          "type": ""
          },
        "bottom": { },
        "left": { },
        "right": { }
      },
      "fill": {
        "color": "",
        "pattern": ""
         },
      "wrapText": "",
      "shrinkToFit": "",
      "locked": ""
    }
  ],
  "sheets": [
    {
      "name": "",
      "frozenPane": "",
      "cols": [
         {
        "width": "",
        "visible": "",
        "style": { },
        "autoWidth": ""
        }
      ],
      "rows": [
        {
          "height": "",
          "visible": "",
           "groupLevel": "",
          "style": { },
          "cells": [
            {
            "value": "",
            "formula": "",
            "style": "0",
            "colSpan": "",
             "rowSpan": ""
            }
          ]
        }
      ]
    }
  ]
}

Description

Generate excel file from JSON data posted from client.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema

{
  "creator": "",
  "created": "",
  "lastModifiedBy": "",
  "modified": "",
  "activeWorksheet": "",
  "styles": [
    {
       "formatCode": "",
      "font": {
        "family": "",
        "size": "",
        "bold": "",
        "italic": "",
        "underline": "",
        "strikethrough": "",
         "color": ""
      },
      "hAlign": "",
      "vAlign": "",
      "indent": "",
      "textRotation": "",
      "textDirection": "",
      "border": {
        "top": {
           "color": "",
          "type": ""
          },
        "bottom": { },
        "left": { },
        "right": { }
      },
      "fill": {
        "color": "",
        "pattern": ""
         },
      "wrapText": "",
      "shrinkToFit": "",
      "locked": ""
    }
  ],
  "sheets": [
    {
      "name": "",
      "frozenPane": "",
      "cols": [
         {
        "width": "",
        "visible": "",
        "style": { },
        "autoWidth": ""
        }
      ],
      "rows": [
        {
          "height": "",
          "visible": "",
           "groupLevel": "",
          "style": { },
          "cells": [
            {
            "value": "",
            "formula": "",
            "style": "0",
            "colSpan": "",
             "rowSpan": ""
            }
          ]
        }
      ]
    }
  ]
}

Description

Convert excel file into different format.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema

{
  "creator": "",
  "created": "",
  "lastModifiedBy": "",
  "modified": "",
  "activeWorksheet": "",
  "styles": [
    {
       "formatCode": "",
      "font": {
        "family": "",
        "size": "",
        "bold": "",
        "italic": "",
        "underline": "",
        "strikethrough": "",
         "color": ""
      },
      "hAlign": "",
      "vAlign": "",
      "indent": "",
      "textRotation": "",
      "textDirection": "",
      "border": {
        "top": {
           "color": "",
          "type": ""
          },
        "bottom": { },
        "left": { },
        "right": { }
      },
      "fill": {
        "color": "",
        "pattern": ""
         },
      "wrapText": "",
      "shrinkToFit": "",
      "locked": ""
    }
  ],
  "sheets": [
    {
      "name": "",
      "frozenPane": "",
      "cols": [
         {
        "width": "",
        "visible": "",
        "style": { },
        "autoWidth": ""
        }
      ],
      "rows": [
        {
          "height": "",
          "visible": "",
           "groupLevel": "",
          "style": { },
          "cells": [
            {
            "value": "",
            "formula": "",
            "style": "0",
            "colSpan": "",
             "rowSpan": ""
            }
          ]
        }
      ]
    }
  ]
}

Description

Merge multiple excel files available in file storage.

Parameters


Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema

{
  "creator": "",
  "created": "",
  "lastModifiedBy": "",
  "modified": "",
  "activeWorksheet": "",
  "styles": [
    {
       "formatCode": "",
      "font": {
        "family": "",
        "size": "",
        "bold": "",
        "italic": "",
        "underline": "",
        "strikethrough": "",
         "color": ""
      },
      "hAlign": "",
      "vAlign": "",
      "indent": "",
      "textRotation": "",
      "textDirection": "",
      "border": {
        "top": {
           "color": "",
          "type": ""
          },
        "bottom": { },
        "left": { },
        "right": { }
      },
      "fill": {
        "color": "",
        "pattern": ""
         },
      "wrapText": "",
      "shrinkToFit": "",
      "locked": ""
    }
  ],
  "sheets": [
    {
      "name": "",
      "frozenPane": "",
      "cols": [
         {
        "width": "",
        "visible": "",
        "style": { },
        "autoWidth": ""
        }
      ],
      "rows": [
        {
          "height": "",
          "visible": "",
           "groupLevel": "",
          "style": { },
          "cells": [
            {
            "value": "",
            "formula": "",
            "style": "0",
            "colSpan": "",
             "rowSpan": ""
            }
          ]
        }
      ]
    }
  ]
 }

Description

Merge multiple files posted from client.

Parameters

Request Url

        

Show Json Data by FlexGrid

Show XML Data

    

Response Schema

{
  "creator": "",
  "created": "",
  "lastModifiedBy": "",
  "modified": "",
  "activeWorksheet": "",
  "styles": [
    {
       "formatCode": "",
      "font": {
        "family": "",
        "size": "",
        "bold": "",
        "italic": "",
        "underline": "",
        "strikethrough": "",
         "color": ""
      },
      "hAlign": "",
      "vAlign": "",
      "indent": "",
      "textRotation": "",
      "textDirection": "",
      "border": {
        "top": {
           "color": "",
          "type": ""
          },
        "bottom": { },
        "left": { },
        "right": { }
      },
      "fill": {
        "color": "",
        "pattern": ""
         },
      "wrapText": "",
      "shrinkToFit": "",
      "locked": ""
    }
  ],
  "sheets": [
    {
      "name": "",
      "frozenPane": "",
      "cols": [
         {
        "width": "",
        "visible": "",
        "style": { },
        "autoWidth": ""
        }
      ],
      "rows": [
        {
          "height": "",
          "visible": "",
           "groupLevel": "",
          "style": { },
          "cells": [
            {
            "value": "",
            "formula": "",
            "style": "0",
            "colSpan": "",
             "rowSpan": ""
            }
          ]
        }
      ]
    }
  ]
 }

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

{
    "success": true,
    "message: "",
    "data": ["string"]
}

Description

Find text in excel, return all matches info.

Parameters

Request Url

        

Response Data

        

Response Schema

{
    "success": true,
    "message: "",
    "data": [
        {
            "sheetName": "Sheet1",
            "rowIndex": 0,
            "columnIndex": 0,
            "startIndex": 0
        }
    ]
}

Description

Replace text in excel.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema

{
    "success": true,
    "message: "",
    "data": {
        "replaceCount": 0
    }
}

Description

Add rows.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema

{
    "success": true,
    "message: "",
    "data": null
}

Description

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

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema

{
    "success": true,
    "message: "",
    "data": null
}

Description

Delete rows.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema

{
    "success": true,
    "message: "",
    "data": null
}

Description

Add columns.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema

{
    "success": true,
    "message: "",
    "data": null
}

Description

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

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema

{
    "success": true,
    "message: "",
    "data": null
}

Description

Delete columns.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema

{
    "success": true,
    "message: "",
    "data": null
}

Description

Upload a file to storage.

Parameters

Request Url

        

Response Data

        
View Files:

Response Schema

{
    "success": true
}

Description

Delete a file from storage.

Parameters

Request Url

        

Response Data

        

Response Schema

{
    "success": true
}

Description

List all files, folders from target folder.

Parameters

Request Url

        

Response Data

        

Response Schema

{
    "success": true
}

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

[
      {
        "header": "",
        "binding": "",
        "dataType": //a number value indicates the data type of the field
        "dimensionType": //the dimension type of the field
        "subFields": []//the child fields
      },
      ...
]

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema

{
  "value": [...] //the data item array
  "totalCount": //the total count of the raw data without paging.
}

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

{
  "value": [...] //the data item array
  "totalCount": //the total count of the detail data without paging.
}

Response Messages

Description

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

Parameters

Headers

        

Response Data

        

Response Schema

[...] //the unique value list array.

Response Messages

Description

Analyze the data from the specified data source.

Parameters

Headers

        

Response Data

        

Response Schema

{
  "token": ""
  "status":
  {
    executingStatus: ""//Five possible status: "NotSet", "Executing", "Exception", "Completed" and "Cancelled".
    "progress": //a number value indicates the analysis progress.
  }
  "result":[...] //the aggregated result data. If the analysis finished normally, it returns the result data. Otherwise, it is null.
}

Response Messages

Description

Get the status of the analysis.

Parameters

Headers

        

Response Data

        

Response Schema

{
  "status": ""
  "progress": //a number value indicates the analysis progress.
}

Response Messages

Description

Get the analysis result data.

Parameters

Headers

        

Response Data

        

Response Schema

[...] //the aggregated data list

Response Messages

Description

Get the analysis information.

Parameters

Headers

        

Response Data

        

Response Schema

{
  "token": ""
  "status":
  {
    executingStatus: ""//Five possible status: "NotSet", "Executing", "Exception", "Completed" and "Cancelled".
    "progress": //a number value indicates the analysis progress.
  }
  "result":[...] //the aggregated result data. If the analysis finished normally, it returns the result data. Otherwise, it is null.
}

Response Messages

Description

Clear the analysis.

Parameters

Headers

        

Response Data

        

Response Schema

No content.

Response Messages