POST api/Export/excelformatted/{workbookDocumentConfigurationId}/{isFullWorkbook}

Use this endpoint to generate a Formatted Excel Workbook (xlsx). To export the entire workbook, pass in the current workbookDocumentConfigurationId and "true" for isFullWorkbook. To export a single Report, pass in the workbookDocumentConfigurationId and "false" for isFullWorkbook. To export the current executed UNSAVED Grid, pass in 0 for workbookDocumentConfigurationId, "false" for isFullWorkbook and valid criteriaAndOptions (QueryCriteria). To export multiple Reports, pass in the current workbookDocumentConfigurationId, "false" for isFullWorkbook and the Report Names as part of the Body options.sheets (String Array)

Request Information

URI Parameters

Name	Description	Type	Additional information
workbookDocumentConfigurationId	The workbookDocumentConfigurationId	integer	Required
isFullWorkbook	A boolean flag	boolean	Required

Body Parameters

An ExportOptions object AND a QueryCriteria object as a string : "excludeSpaceInTabs": false, "includeNumberInTabs": false, "industryView": null, "productId": 0, "sheets": null, (String List of Report Names) "userType": null, "processEmbeddedUniverses": true

SI.API.Controllers.Simfund.QueryCriteriaAndExportOptions

Name	Description	Type	Additional information
ExportOptions		SI.Web.Export.DevEx.Simfund.ExportOptions	None.
QueryCriteriaString		string	None.

Request Formats

application/json, text/json

Sample:

{
  "ExportOptions": {
    "ExcludeSpaceInTabs": true,
    "IncludeNumberInTabs": true,
    "IndustryView": "sample string 3",
    "ProductId": 4,
    "Sheets": [
      "sample string 1",
      "sample string 2"
    ],
    "UserType": "sample string 5",
    "ProcessEmbeddedUniverses": true
  },
  "QueryCriteriaString": "sample string 1"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A Formatted Excel Workbook

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.