Home

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.

Excel

Import/Export Services

MVC Controls

Wijmo5 Controls

Generate Excel

GET

/api/excel

Generate from dataset\collection

Description

Generate excel file from dataset\collection configured on server.

Parameters

Parameter Value Description

FileName The exported file name.

TemplateFileName The Template file name (if not provide, use generated template automatically).

Type The file format of the excel

DataName The data name that data provider recognizes.

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": ""
            }
          ]
        }
      ]
    }
  ]
}

GET

/api/excel

Generate from XML

Description

Generate excel file from XML file available in storage.

Parameters

Parameter Value Description

FileName The exported file name.

TemplateFileName The Template file name (if not provide, use generated template automatically).

Type The file format of the excel

DataFileName The xml data file name that storage manager can recognize. The content of the xml data file is collection-like, a root element with multiple same elements as its children:

<orders>
    <order id="1">
        <price>1000</price>
    </order>
    ......
 </orders>

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": ""
            }
          ]
        }
      ]
    }
  ]
}

GET

/api/excel

Convert between different formats

Description

Convert excel file available in storage into different format.

Parameters

Parameter Value Description

FileName The exported file name.

Type The file format of the excel

WorkBookFileName The excel file name that storage manager can recognize.

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": ""
            }
          ]
        }
      ]
    }
  ]
}

POST

/api/excel

Generate from XML

Description

Generate excel file from XML file posted from client.

Parameters

Parameter Value Description

FileName The exported file name.

TemplateFile The Template file (if not provide, use generated template automatically).

Type The file format of the excel.

DataFile The xml data file which is posted from client side.The content of the xml data file is collection-like, a root element with multiple same elements as its children:

<orders>
    <order id="1">
        <price>1000</price>
    </order>
    ......
 </orders>

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": ""
            }
          ]
        }
      ]
    }
  ]
}

POST

/api/excel

Generate from JSON

Description

Generate excel file from JSON data posted from client.

Parameters

Parameter Value Description

FileName The exported file name.

TemplateFileName The Template file name (if not provide, use generated template automatically).

Type The file format of the excel.

Data

[
    {
        "id": 0,
        "date": "2015-06-24T16:00:00.000Z",
        "time": "2015-08-18T18:50:00.000Z",
        "country": "Japan", "countryMapped": 3,
        "downloads": 436, "sales": 4314.523264765739,
        "expenses": 4330.620157998055,
        "checked": true
    },
    {
        "id": 1,
        "date": "2015-02-28T16:00:00.000Z",
        "time": "2015-05-19T21:01:00.000Z",
        "country": "Italy",
        "countryMapped": 4,
        "downloads": 676,
        "sales": 2558.132621925324,
        "expenses": 1959.2562899924815,
        "checked": false
    },
    {
        "id": 2,
        "date": "2015-07-04T16:00:00.000Z",
        "time": "2015-03-20T02:19:00.000Z",
        "country": "Germany",
        "countryMapped": 1,
        "downloads": 488,
        "sales": 6382.134975865483,
        "expenses": 4719.182880362496,
        "checked": false
    },
    {
        "id": 3,
        "date": "2015-02-08T16:00:00.000Z",
        "time": "2015-10-05T08:52:00.000Z",
        "country": "Italy",
        "countryMapped": 4,
        "downloads": 964,
        "sales": 7840.539840981364,
        "expenses": 375.3066179342568,
        "checked": false
    },
    {
        "id": 4,
        "date": "2015-03-14T16:00:00.000Z",
        "time": "2015-10-04T09:20:00.000Z",
        "country": "Italy",
        "countryMapped": 4,
        "downloads": 706,
        "sales": 6771.57775266096,
        "expenses": 4210.299032274634,
        "checked": false
    }
]

A data collection which is posted from client side.

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": ""
            }
          ]
        }
      ]
    }
  ]
}

POST

/api/excel

Convert between different formats

Description

Convert excel file into different format.

Parameters

Parameter Value Description

FileName The exported file name.

Type The file format of the excel.

WorkbookFile The excel file which is posted from client side. The file can be: xls, xlsx, csv.

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": ""
            }
          ]
        }
      ]
    }
  ]
}

Merge Excel Files

GET

/api/excel/merge

Description

Merge multiple excel files available in file storage.

Parameters

Parameter Value Description

FileName The exported file name.

Type The file format of the excel.

FileNamesToMerge
The excel file names that storage manager can recognize.

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": ""
            }
          ]
        }
      ]
    }
  ]
 }

POST

/api/excel/merge

Description

Merge multiple files posted from client.

Parameters

Parameter Value Description

FileName The exported file name.

Type The file format of the excel.

FilesToMerge The excel file names that storage manager can recognize.

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": ""
            }
          ]
        }
      ]
    }
  ]
 }

Split Excel File

GET

/api/excel/{excel path}/split

Description

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

Parameters

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Output Path The output path in storage(if not provide, the default output path same as source).

Output Names The output file names (if not provide, the output file names will be generated automatically).

Request Url

Response Data

View Files:

Response Schema

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

Find/Replace

GET

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

Description

Find text in excel, return all matches info.

Parameters

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Sheet Name The sheet name (if not provide, find in all sheets).

Text The value which is used to search.

Match Case A boolean value indicates whether to search the value with case sensitive.

Whole Cell A boolean value indicates whether to search the value with matching the whole cell.

Request Url

Response Data

Response Schema

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

GET

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

Description

Replace text in excel.

Parameters

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Sheet Name The sheet name (if not provide, replace in all sheets).

Text The text which is replaced.

New Text The new text to replace.

Match Case A boolean value indicates whether to search the value with case sensitive.

Whole Cell A boolean value indicates whether to search the value with matching a whole word.

Request Url

Response Data

View Files:

Response Schema

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

Rows

POST

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

Description

Add rows.

Parameters

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Sheet Name The sheet name.

Row Index The row index.

Count The count of rows.

Request Url

Response Data

View Files:

Response Schema

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

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

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Sheet Name The sheet name.

Row Indexes the row indexes. format: {num}; {num},{num},...; {num}-{num}. for example: 1,3-5

Property Name The property name of row, available properties are "Visible(bool)" and "OutlineLevel(int)"

Property Value The property value of row.

Request Url

Response Data

View Files:

Response Schema

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

DELETE

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

Description

Delete rows.

Parameters

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Sheet Name The sheet name.

Row Indexes the row indexes. format: {num}; {num},{num},...; {num}-{num}. for example: 1,3-5

Request Url

Response Data

View Files:

Response Schema

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

Columns

POST

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

Description

Add columns.

Parameters

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Sheet Name The sheet name.

Column Index The column index.

Count The count of columns.

Request Url

Response Data

View Files:

Response Schema

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

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

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Sheet Name The sheet name.

Column Indexes The column indexes. format: {num}; {num},{num},...; {num}-{num}. for example: 1,3-5

Property Name The property name of column, available properties are "Visible(bool)" and "OutlineLevel(int)"

Property Value The property value of column.

Request Url

Response Data

View Files:

Response Schema

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

DELETE

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

Description

Delete columns.

Parameters

Parameter Value Description

Excel Path The excel file name that storage manager can recognize.

Sheet Name The sheet name.

Column Indexes The column indexes. format: {num}; {num},{num},...; {num}-{num}. for example: 1,3-5

Request Url

Response Data

View Files:

Response Schema

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

Storage

FileManager sample

FileManager Control

File Management

POST

/api/storage/{path}

Description

Upload a file to storage.

Parameters

Parameter Value Description

path

The file path in storage. DropBox : DropBox/C1WebApi/test.xlsx
step 1: login to your DropBox acount.
step 2: create an App and generate Access Token for this app.
step 3: use Access Token created at step 2 to put into DropBoxStorageAccessToken
key value in the Web.config.
step 4: open WebApiExplorer project and navigate to Storage api section.
step 5: change "C1WebApi" to your apps name.
step 6: change "test.xlsx" to your file name you want to post.
NOTE: if using List Api, need change "test1" to your sub folder path.
For more information, please refer sample ~\WebApi\Samples\CS

file The upload file. (for demo, please choose a .xlsx file)

Request Url

Response Data

View Files:

Response Schema

{
    "success": true
}

DELETE

/api/storage/{path}

Description

Delete a file from storage.

Parameters

Parameter Value Description

path

Request Url

Response Data

Response Schema

{
    "success": true
}

GET

/api/storage/List/{path}

Description

List all files, folders from target folder.

Parameters

Parameter Value Description

path

DropBox : DropBox/C1WebApi/test.xlsx
step 1: login to your DropBox acount.
step 2: create an App and generate Access Token for this app.
step 3: use Access Token created at step 2 to put into DropBoxStorageAccessToken
key value in the Web.config.
step 4: open WebApiExplorer project and navigate to Storage api section.
step 5: change "C1WebApi" to your apps name.
step 6: change "test.xlsx" to your file name you want to post.
NOTE: if using List Api, need change "test1" to your sub folder path.
For more information, please refer sample ~\WebApi\Samples\CS

Request Url

Response Data

Response Schema

{
    "success": true
}

Report

Report List

GET

/api/report/{folder path}

Description

Gets the report list in the specified folder path.

Parameters

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Recursive A boolean value indicates whether get all reports under the path.

Headers

Response Data

Response Schema

[
    {
        "name": "string",
        "path": "string",
        "type": 0,
        "items": [{ }]
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains the ICatalogItem object which describes the folder or report.

404 The folder path or report path does not exist.

Report

GET

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

Description

Gets the info of the specified report.

Parameters

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Headers

Response Data

Response Schema

{
    "path": "string",
    "hasParameters": false,
    "pageSettings": {
        "paginated": true,
        "height": "string",
        "width": "string",
        "topMargin": "string",
        "leftMargin": "string",
        "rightMargin": "string",
        "bottomMargin": "string",
        "landscape": false,
        "paperSize": 1
    },
    "parametersLocation": "string",
    "pageSettingsLocation": "string",
    "supportedFormatsLocation": "string",
    "creationLocation": "string"
}

Response Messages

HTTP Status Code Reason

200 Json string contains IReportInfo type object.

404 The report path does not exist.

GET

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

Description

Gets the default page settings defined in the specified report.

Parameters

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Headers

Response Data

Response Schema

{
    "paginated": true,
    "height": "string",
    "width": "string",
    "topMargin": "string",
    "leftMargin": "string",
    "rightMargin": "string",
    "bottomMargin": "string",
    "landscape": false,
    "paperSize": 1
}

Response Messages

HTTP Status Code Reason

200 Json string contains IPageSettings type object.

404 The report path does not exist.

GET

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

Description

Get all the parameters defined in the report.

Parameters

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Headers

Response Data

Response Schema

[
    {
        "name": "string",
        "dataType": 0,
        "nullable": true,
        "allowedValues": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "value": { },
        "hidden": true,
        "multiValue": true,
        "prompt": "string",
        "error": "string",
        "allowBlank": true,
        "maxLegnth": 0
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of IParameter.

404 The report path does not exist.

GET

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

Description

Get specified parameter defined in the report.

Parameters

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Parameter Name The parameter name. e.g: pCategory

Headers

Response Data

Response Schema

{
    "name": "string",
    "dataType": 0,
    "nullable": false,
    "allowedValues": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "value": { },
    "hidden": false,
    "multiValue": true,
    "prompt": "string",
    "error": "string",
    "allowBlank": true,
    "maxLegnth": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IParameter type object.

404 The report path or parameter name does not exist.

GET

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

Description

Get all the supported export formats.

Parameters

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Headers

Response Data

Response Schema

[
    {
        "name": "string",
        "format": "string",
        "optionDescriptions": [
            {
                "name": "string",
                "type": "string",
                "nullable": true,
                "defaultValue": "string",
                "allowedValues": ["string"]
            }
        ]
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of IExportDescription.

404 The report path does not exist.

GET

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

Description

Get specified supported format.

Parameters

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Supported Format Name The supported format name. e.g: html

Headers

Response Data

Response Schema

{
    "name": "string",
    "format": "string",
    "optionDescriptions": [
        {
            "name": "string",
            "type": "string",
            "nullable": false,
            "defaultValue": "string",
            "allowedValues": ["string"]
        }
    ]
}

Response Messages

HTTP Status Code Reason

200 Json string contains IExportDescription type object.

404 The report path or format name does not exist.

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

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Format The supported formats, please see the response of action supportedformats.

Export File Name The exported file name.

Report Parameters Suggest to use report FlexCommonTasks.flxr/MultiValue DataBound Parameters as example.
The report parameters, please see the response of action parameters. e.g:
parameters.pCategory=1&...

If the parameter is multi-value, please set the parameters for many times, e.g:
parameters.pCategory=1&parameters.pCustomers=3&...

Export Options The export options, please see the response of action supportedformats. e.g:
exportOptions.outputRange=1&...

Report Page Settings Please set the page settings like: pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm

Headers

Response Schema

[file stream]

Response Messages

HTTP Status Code Reason

200 The exported file stream.

404 The report path or format name does not exist.

406 The format name is not acceptable.

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

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Format The supported formats, please see the response of action supportedformats.

Export File Name The exported file name.

Export Options The export options, please see the response of action supportedformats. e.g:
exportOptions.outputRange=1&...

Report Page Settings Please set the page settings like: pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm

Headers

Response Schema

[file stream]

Response Messages

HTTP Status Code Reason

200 The exported file stream.

404 The report path or format name does not exist.

406 The format name is not acceptable.

Report Instance

POST

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

Description

Creates new report instance from the specified report.

Parameters

Parameter Value Description

Folder Path The folder path that report provider manager can recognize.

Report Name The report name that is defined in the FlexReport file, or under the SSRS folder.

Report Page Settings Please set the page settings like: pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm

Headers

Response Data

Response Schema

{
    "id": "string",
    "hasParameters": false,
    "parametersLocation": "string",
    "status": {
        "expiredDateTime": "string",
        "hasOutlines": false,
        "status": "string",
        "errorList": [],
        "progress": 0,
        "pageCount": 0
    },
    "loadedDateTime": "string",
    "expiredDateTime": "string",
    "path": "string",
    "pageSettings": {
        "paginated": true,
        "height": "string",
        "width": "string",
        "topMargin": "string",
        "leftMargin": "string",
        "rightMargin": "string",
        "bottomMargin": "string",
        "landscape": false,
        "paperSize": 1
    },
    "features": {
        "nonPaginated": false,
        "paginated": true,
        "textSearchInPaginatedMode": true,
        "pageSettings": true
    },
    "outlinesLocation": "string",
    "statusLocation": "string",
    "pageSettingsLocation": "string",
    "featuresLocation": "string",
    "supportedFormatsLocation": "string"
}

Response Messages

HTTP Status Code Reason

201 Json string contains IReportInstanceInfo type object, for the new created instance.

404 The report path does not exist.

GET

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

Description

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

Parameters

Parameter Value Description

Report Full Path The full path of executing report.

Cache Id The instance id of executing report.

Headers

Response Data

Response Schema

{
    "id": "string",
    "hasParameters": false,
    "parametersLocation": "string",
    "status": {
        "expiredDateTime": "string",
        "hasOutlines": false,
        "status": "string",
        "errorList": [],
        "progress": 0,
        "pageCount": 0
    },
    "loadedDateTime": "string",
    "expiredDateTime": "string",
    "path": "string",
    "pageSettings": {
        "paginated": true,
        "height": "string",
        "width": "string",
        "topMargin": "string",
        "leftMargin": "720tw",
        "rightMargin": "string",
        "bottomMargin": "string",
        "landscape": false,
        "paperSize": 1
    },
    "features": {
        "nonPaginated": false,
        "paginated": true,
        "textSearchInPaginatedMode": true,
        "pageSettings": true
    },
    "outlinesLocation": "string",
    "statusLocation": "string",
    "pageSettingsLocation": "string",
    "featuresLocation": "string",
    "supportedFormatsLocation": "string"
}

Response Messages

HTTP Status Code Reason

200 Json string contains IReportInstanceInfo type object.

404 The report path or instance id does not exist.

POST

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

Description

Renders the report instance with the specified instance id.

Parameters

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The cache id of executing report.

Report Page Settings Please set the page settings like: pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm

Action String The action string. This is only for SSRS report and suggest to use report AdventureWorks (SSRS)/Product Line Sales as example. e.g:
actionString=77u%2FPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48TFQgcmVmPSIxIiB0eXBlPSJMVCI%2BPERBIHR5cGU9IlNTUlNTQSI%2BPFNJRD4zM2lUMDwvU0lEPjxEPkFzY2VuZGluZzwvRD48L0RBPjwvTFQ%2B

Headers

Response Data

Response Messages

HTTP Status Code Reason

200 (Render completed.) Json string contains IReportStatus type object.

202 (On Rendering.) The render action is accepted.

404 The report path or instance id does not exist.

GET

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

Description

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

Parameters

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The cache id of executing report.

Headers

Response Data

Response Schema

{
    "expiredDateTime": "string",
    "hasOutlines": false,
    "status": "string",
    "errorList": [],
    "progress": 0,
    "pageCount": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IReportStatus type object.

404 The report path or instance id does not exist.

GET

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

Description

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

Parameters

Parameter Value Description

Report Full Path The full path of executing report.
Suggest to use report FlexCommonTasks.flxr/MultiValue DataBound Parameters as example.

Instance Id The instance id of executing report.

Headers

Response Data

Response Schema

[
    {
        "name": "string",
        "dataType": 0,
        "nullable": true,
        "allowedValues": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "value": { },
        "hidden": true,
        "multiValue": true,
        "prompt": "string",
        "error": "string",
        "allowBlank": true,
        "maxLegnth": 0
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of IParameter.

404 The report path or instance id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.
Suggest to use report FlexCommonTasks.flxr/MultiValue DataBound Parameters as example.

Instance Id The instance id of executing report.

Report Parameters The report parameters, please see the response of action parameters. e.g:
pCategory=1&...

If the parameter is multi-value, please set the parameters for many times, e.g:
pCategory=1&pCustomers=3&...

Headers

Response Data

Response Schema

[
    {
        "name": "string",
        "dataType": 0,
        "nullable": true,
        "allowedValues": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "value": { },
        "hidden": true,
        "multiValue": true,
        "prompt": "string",
        "error": "string",
        "allowBlank": true,
        "maxLegnth": 0
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of IParameter which are the new parameters with validation.

404 The report path or instance id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.
Suggest to use report FlexCommonTasks.flxr/MultiValue DataBound Parameters as example.

Instance Id The instance id of executing report.

Headers

Response Data

Response Schema

[
    {
        "name": "string",
        "dataType": 0,
        "nullable": true,
        "allowedValues": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "value": { },
        "hidden": true,
        "multiValue": true,
        "prompt": "string",
        "error": "string",
        "allowBlank": true,
        "maxLegnth": 0
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of IParameter which are the new parameters with validation.

404 The report path or instance id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.
Suggest to use report FlexCommonTasks.flxr/MultiValue DataBound Parameters as example.

Instance Id The instance id of executing report.

Parameter Name The parameter name.

Headers

Response Data

Response Schema

{
    "name": "string",
    "dataType": 0,
    "nullable": true,
    "allowedValues": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "value": { },
    "hidden": true,
    "multiValue": true,
    "prompt": "string",
    "error": "string",
    "allowBlank": true,
    "maxLegnth": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IParameter type object.

404 The report path or instance id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report. Suggest to use report FlexCommonTasks.flxr/MultiValue DataBound Parameters as example.

Instance Id The instance id of executing report.

Parameter Name The parameter name.

Parameter Values The report parameter values. e.g:
value=1&...

Headers

Response Data

Response Schema

{
    "name": "string",
    "dataType": 0,
    "nullable": true,
    "allowedValues": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "value": { },
    "hidden": true,
    "multiValue": true,
    "prompt": "string",
    "error": "string",
    "allowBlank": true,
    "maxLegnth": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IParameter type object which is the new parameter with validation.

404 The report path or instance id or parameter name does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Headers

Response Data

Response Schema

{
    "paginated": true,
    "height": "string",
    "width": "string",
    "topMargin": "string",
    "leftMargin": "string",
    "rightMargin": "string",
    "bottomMargin": "string",
    "landscape": false,
    "paperSize": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IPageSettings type object.

404 The report path or instance id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Report Page Settings Please set the page settings like: paperSize=custom&height=10in&width=20.5cm

Headers

Response Data

Response Schema

{
    "paginated": true,
    "height": "string",
    "width": "string",
    "topMargin": "string",
    "leftMargin": "string",
    "rightMargin": "string",
    "bottomMargin": "string",
    "landscape": false,
    "paperSize": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IPageSettings type object which is the new page settings. Use the default value if one property is not set.

404 The report path or instance id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Report Page Settings Please set the page settings like: paperSize=custom&height=10in&width=20.5cm

Headers

Response Data

Response Schema

{
    "paginated": true,
    "height": "string",
    "width": "string",
    "topMargin": "string",
    "leftMargin": "string",
    "rightMargin": "string",
    "bottomMargin": "string",
    "landscape": false,
    "paperSize": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IPageSettings type object which is the new page settings.

404 The report path or instance id does not exist.

GET

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

Description

Get all the supported export formats.

Parameters

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Headers

Response Data

Response Schema

[
    {
        "name": "string",
        "format": "string",
        "optionDescriptions": [
            {
                "name": "string",
                "type": "string",
                "nullable": true,
                "defaultValue": "string",
                "allowedValues": ["string"]
            }
        ]
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of IExportDescription.

404 The report path or instance id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Supported Format Name The supported format name. e.g: html

Headers

Response Data

Response Schema

{
    "name": "string",
    "format": "string",
    "optionDescriptions": [
        {
            "name": "string",
            "type": "string",
            "nullable": false,
            "defaultValue": "string",
            "allowedValues": ["string"]
        }
    ]
}

Response Messages

HTTP Status Code Reason

200 Json string contains IExportDescription type object.

404 The report path or instance id or format name does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Headers

Response Data

Response Schema

{
    "nonPaginated": false,
    "paginated": true,
    "textSearchInPaginatedMode": true,
    "pageSettings": true
}

Response Messages

HTTP Status Code Reason

200 Json string contains IDocumentFeatures type object.

404 The report path or instance id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Format The supported formats, please see the response of action supportedformats.

Export File Name The exported file name.

Export Options The export options, please see the response of supportedformats action. E.g:
outputRange=1&...

Headers

Response Schema

[file stream]

Response Messages

HTTP Status Code Reason

200 The exported file stream.

404 The report path or instance id does not exist or the request page range is not rendered. (The report is not render completed.)

406 The format name is not acceptable.

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

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Format The supported formats, please see the response of action supportedformats.

Export File Name The exported file name.

Export Options The export options, please see the response of supportedformats action. E.g:
outputRange=1&...

Headers

Response Schema

[file stream]

Response Messages

HTTP Status Code Reason

200 The exported file stream.

404 The report path or instance id does not exist or the request page range is not rendered. (The report is not render completed.)

406 The format name is not acceptable.

GET

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

Description

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

Parameters

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Headers

Response Data

Response Schema

[
    {
        "caption": "string",
        "children": [{ }],
        "level": 0,
        "target": "string"
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains collection of IOutlineNode type objects.

404 The report path or instance id does not exist.

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)

Parameter Value Description

Report Full Path The full path of executing report.
Suggest to use report FlexCommonTasks.flxr/Report Navigation as example.

Instance Id The instance id of executing report.

Bookmark Name The bookmark name.

Headers

Response Data

Response Schema

{
    "pageBounds": {
        "x": 0,
        "y": 0,
        "width":0,
        "height": 0
    },
    "pageIndex": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IDocumentPosition type object.

404 The report path or instance id or bookmark id does not exist.

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

Parameter Value Description

Report Full Path The full path of executing report.
Suggest to use report FlexCommonTasks.flxr/Simple List as example.

Instance Id The instance id of executing report.

Start Page Index 0-based index of the first page to search.

Search Scope The search scope.

Search Text The value which is used to search.

Match Case A boolean value indicates if search the value with case sensitive.

Whole Word A boolean value indicates if search the value with matching a whole word.

Headers

Response Data

Response Schema

[
    {
        "nearText": "string",
        "positionInNearText": 0,
        "boundsList": [
            {
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0
            }
        ],
        "pageIndex": 0
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of ISearchResult type objects.

404 The report path or instance id does not exist.

POST

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

Description

Stop the current rendering.

Parameters

Parameter Value Description

Report Full Path The full path of executing report.

Instance Id The instance id of executing report.

Headers

Response Data

Response Schema

{
    "expiredDateTime": "string",
    "hasOutlines": false,
    "status": "string",
    "errorList": [],
    "progress": 0,
    "pageCount": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IReportStatus type object.

404 The report path or instance id does not exist.

DELETE

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

Description

Delete the instance.

Parameters

Parameter Value Description

Report Full Path The full path of executing report.

Cache Id The instance id of executing report.

Headers

Response Data

Response Messages

HTTP Status Code Reason

204 Succeed to delete the instance.

404 The report path or instance id does not exist.

Barcode

Generate Barcode

GET

/api/barcode

Description

API to generate barcode

Parameters

Bacis Settings

Parameter Value Description

Type The file type of the barcode image.

Text The value that is encoded as a barcode image.

CodeType The type of encoding to use when generating the barcode image.

BackColor Gets or sets the background color for the barcode image.

ForeColor Gets or sets the foreground color for the barcode image.

CaptionPosition Barcode caption position relative to the barcode symbol.

CaptionAlignment Barcode caption alignment relative to the barcode.

CheckSumEnabled Gets or sets a value indicating whether a checksum of the barcode will be computed and included in the barcode when applicable.

QRCode Settings

Model Gets or sets the QRCode model.

ErrorLevel Gets or sets the error correction level for the barcode.

Version Gets or sets the QRCode version. Specify any value between 1 and 14 when the Model property is set to Model1 and 1 to 40 for Model2. When -1 is specified, the version most suited to the value is automatically determined.

Mask Gets or sets the pattern used for the barcode masking.

ConnectionNumber Gets or sets the connection number for the barcode.

Connection Gets or sets whether connection is used for the barcode.

PDF417 Settings

Column Gets or sets columns number for the barcode.

Row Gets or sets row numbers for the barcode.

ErrorLevel Gets or sets the error correction level for the barcode.

Type Gets or set the PDF417 barcode's type.

Code49 Settings

Group Gets or sets groups number.

Grouping Gets or sets a value indicating whether grouping is set for the barcode.

RssExpandedStacked Settings

RowCount Gets or sets the number of stacked rows.

MicroPDF417 Settings

CompactionMode Gets or sets the CompactionMode.

FileID Gets or sets the file id of structured append symbol.

SegmentCount Gets or sets the segment count of structured append symbol.

SegmentIndex Gets or sets the segment index of structured append symbol.

Version Gets or sets the symbol version.

Code25intlv Settings

LineStroke The color of bearer bar.

BearBar Whether or not to display bearer bar to ITF barcode.

LineStrokeThickness The line width of bearer bar.

GS1Composite Settings

Type Gets or sets the composite symbol type.

Value Gets or sets the CCA or CCB character data.

Ean128Fnc1 Settings

BarAdjust Gets or sets the adjustment size by dot.

Dpi Gets or sets the resolution of the printer.

ModuleSize Gets or sets the horizontal size of the barcode module.

DataMatrix Settings

EccMode Gets or sets the ECC mode.

Ecc200SymbolSize Gets or sets the size of the ECC200 symbol.

Ecc200EncodingMode Gets or sets the ECC200 encoding mode.

Ecc000_140SymbolSize Gets or sets the size of the ECC000-140 symbol.

StructureNumber Gets or sets the structure number of current symbol within the structured append symbols.

StructuredAppend Gets or sets a value indicating whether the current symbol is part of structured append symbols.

FileIdentifier Gets or sets the file identifier of a related group of structured append symbols.

Request Url

Barcode

DataEngine

Samples for Services

MVC Controls

Wijmo5 Controls

Services

GET

/api/dataengine/{datasource}/fields

Description

Gets all the fields in the data.

Parameters

Parameter Value Description

Data Source The data source to get the fields information.

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

HTTP Status Code Reason

200 A field array is returned.

404 {datasource} is invalid.

GET

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

Description

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

Parameters

Parameter Value Description

Data Source The data source to analyze.

Skip A positive integer value to specify the start index of the whole raw data. If not set, then returns the entries from the first one.

Top A positive integer value to specify the count of the returned raw data. If not set, then returns all entries starting with the skip value.

Headers

Response Data

Response Schema

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

Response Messages

HTTP Status Code Reason

200 An IRawData object is returned to specify the aggregated result information. It includes two items: an array for the aggregated data and a number value for the total count of all the raw data without paging.

404 {datasource} is invalid.

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

Parameter Value Description

Data Source The data source to analyze.

Skip A positive integer value to specify the start index of the whole detail entries. If not set, then returns the entries from the first one.

Top A positive integer value to specify the count of the returned detail entries. If not set, then returns all entries starting with the skip value.

View Definition The view definition to analyze. For example:
{
fields:[
   {"binding":"Active","dataType":3},
   {"binding":"Country","dataType":1},
   {"binding":"Date","dataType":4},
   {"binding":"Discount","dataType":2},
   {"binding":"Downloads","dataType":2},
   {"binding":"ID","dataType":2},
   {"binding":"Product","dataType":1},
   {"binding":"Sales","dataType":2}
],
rowFields:{items:["Product"]},
columnFields:{items:["Country"]},
valueFields:{items:["Sales"]}
}

Key Specify the cell via the corresponding value. It is an array object. Firstly, you need add the values of the fields in rowFields in order into keys. Then add the values of the fields in columnFields in order. If some field value is null, JUST add null into array and DO NOT remove it. You should keep the count of the keys array same as the count of the fields in rowFields and columnFields.
For example:
["Aoba", "China"]

Headers

Response Data

Response Schema

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

Response Messages

HTTP Status Code Reason

200 An IRawData object is returned to specify the detail result information. It includes two parts: an array for the raw data of the cell and the total count of the raw data without paging.

404 {datasource} is invalid.

POST

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

Description

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

Parameters

Parameter Value Description

Data Source The data source to analyze.

Field The field to get the unique values for.
For example:
Product

Headers

Response Data

Response Schema

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

Response Messages

HTTP Status Code Reason

200 An array is returned to specify the unique values of a field.

404 {datasource} or {fieldname} is invalid.

POST

/api/dataengine/{datasource}/analyses

Description

Analyze the data from the specified data source.

Parameters

Parameter Value Description

Data Source The data source to analyze.

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

HTTP Status Code Reason

201 An IAnalysis object is returned to specify the analysis result information. It includes the status and the result data. If executingStatus in the status is “Completed”, the result data is an array which stands for the aggregated result data. Otherwise, the result data is always null. Location in response header shows the url to access the analysis instance.

404 {datasource} is invalid.

GET

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

Description

Get the status of the analysis.

Parameters

Parameter Value Description

Data Source The data source to analyze.

Token The token of analysis instance.

Headers

Response Data

Response Schema

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

Response Messages

HTTP Status Code Reason

200 An IStatus object is returned to specify the status. If the status is still “Executing”, you can send this request repeatedly until the status is changed to other values: Completed, Cleared or Exception. When it is “Completed”, it means the query has been executed successfully and the data is prepared. You can get the data by the 7th service: Get: /host/{datasourcekey}/analyses/{token}/result. If the status is “Exception”, it means some error occurs during the executing. For example, the token provided in this request doesn’t exist, an exception would be returned as response.

404 {datasource} or {token} is invalid.

GET

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

Description

Get the analysis result data.

Parameters

Parameter Value Description

Data Source The data source to analyze.

Token The token of analysis instance.

Headers

Response Data

Response Schema

[...] //the aggregated data list

Response Messages

HTTP Status Code Reason

200 An array object is returned to specify the result data. After calling this service to obtain the data prepared, the token will be removed. You cannot use it in other requests then. Otherwise, an exception would be returned.

404 {datasource} or {token} is invalid.

GET

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

Description

Get the analysis information.

Parameters

Parameter Value Description

Data Source The data source to analyze.

Token The token of analysis instance.

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

HTTP Status Code Reason

200 An IAnalysis object is returned to specify the analysis result information.

404 {datasource} or {token} is invalid.

DELETE

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

Description

Clear the analysis.

Parameters

Parameter Value Description

Data Source The data source to analyze.

Token The token of analysis instance.

Headers

Response Data

Response Schema

No content.

Response Messages

HTTP Status Code Reason

204 No content for response.

404 {datasource} or {token} is invalid.

Visitor

Samples for Visitor API

Visitor API

Pdf

GET

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

Description

Get the execution info of the specified pdf.

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Headers

Response Data

Response Schema

{
    "loadedDateTime": "2016/12/23 13:32:44",
    "expiredDateTime": "2016/12/23 14:04:05",
    "path": "string",
    "pageSettings": {
        "paginated": true,
        "height": "string",
        "width": "string",
        "topMargin": "string",
        "leftMargin": "string",
        "rightMargin": "string",
        "bottomMargin": "string",
        "landscape": false,
        "paperSize": 0
    },
    "features": {
        "nonPaginated": false,
        "paginated": true,
        "textSearchInPaginatedMode": false,
        "pageSettings": false
    },
    "status": {
        "expiredDateTime": "2016/12/23 14:04:05",
        "hasOutlines": false,
        "status": "string",
        "errorList": [],
        "progress": 1,
        "pageCount": 1
    },
    "statusLocation": "string",
    "featuresLocation": "string"
}

Response Messages

HTTP Status Code Reason

200 Json string contains IExecutionInfo type object.

404 The pdf path does not exist.

GET

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

Description

Get the status of the specified pdf.

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Headers

Response Data

Response Schema

{
    "expiredDateTime": "2016/12/23 14:30:12",
    "hasOutlines": false,
    "status": "string",
    "errorList": [],
    "progress": 0,
    "pageCount": 0
}

Response Messages

HTTP Status Code Reason

200 Json string contains IDocumentStatus type object.

404 The pdf path does not exist.

GET

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

Description

Get all the supported export formats.

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Headers

Response Data

Response Schema

[
    {
        "name": "string",
        "format": "string",
        "optionDescriptions": [
            {
                "name": "string",
                "type": "string",
                "nullable": true,
                "defaultValue": "string",
                "allowedValues": ["string"]
            }
        ]
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of IExportDescription.

404 The pdf path does not exist.

GET

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

Description

Get all the supported features.

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Headers

Response Data

Response Schema

{
    "nonPaginated": false,
    "paginated": true,
    "textSearchInPaginatedMode": false,
    "pageSettings": false
}

Response Messages

HTTP Status Code Reason

200 Json string contains IDocumentFeatures type object.

404 The pdf path does not exist.

GET

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

Description

Export the pdf to the specified format with options.

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Format The supported formats, please see the response of SupportedFormats action.

Export Options The export options, please see the response of SupportedFormats action. E.g:
outputRange=1&...

Headers

Response Schema

[file stream]

Response Messages

HTTP Status Code Reason

200 The exported file stream.

404 The pdf path does not exist.

406 The format name is not acceptable.

POST

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

Description

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

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Format The supported formats, please see the response of SupportedFormats action.

Export Options The export options, please see the response of SupportedFormats action. E.g:
outputRange=1&...

Headers

Response Schema

[file stream]

Response Messages

HTTP Status Code Reason

200 The exported file stream.

404 The pdf path does not exist.

406 The format name is not acceptable.

GET

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

Description

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

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Start Page Index 0-based index of the first page to search.

Search Scope The search scope.

Search Text The value which is used to search.

Match Case A boolean value indicates if search the value with case sensitive.

Whole Word A boolean value indicates if search the value with matching a whole word.

Headers

Response Data

Response Schema

[
    {
        "nearText": "string",
        "positionInNearText": 0,
        "boundsList": [
            {
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0
            }
        ],
        "pageIndex": 0
    }
]

Response Messages

HTTP Status Code Reason

200 Json string contains a collection of ISearchResult type objects.

404 The pdf path does not exist.