ComponentOne Web API Edition
ExportReport_Get Method

C1.Web.Api.Report Namespace > ReportController Class : ExportReport_Get Method
The full path of the report.
The export options.
The optional exported file name.
The optional parameters for rendering.
The optional page settings for rendering.
Exports the specified report to the specified export filter with options and the specified page settings or/and parameters.
Syntax
'Declaration
 
<HttpGetAttribute()>
<PathRouteAttribute(Template="{*reportPath}$report/export", 
   Name="", 
   ExcludingKeywords=, 
   Order=0)>
Public Overridable Function ExportReport_Get( _
   ByVal reportPath As String, _
   ByVal exportOptions As IDictionary(Of String,String), _
   Optional ByVal exportFileName As String, _
   Optional ByVal parameters As IDictionary(Of String,String()), _
   Optional ByVal pageSettings As PageSettings _
) As IHttpActionResult
[HttpGet()]
[PathRoute(Template="{*reportPath}$report/export", 
   Name="", 
   ExcludingKeywords=, 
   Order=0)]
public virtual IHttpActionResult ExportReport_Get( 
   string reportPath,
   IDictionary<string,string> exportOptions,
   string exportFileName,
   IDictionary<string,string[]> parameters,
   PageSettings pageSettings
)

Parameters

reportPath
The full path of the report.
exportOptions
The export options.
exportFileName
The optional exported file name.
parameters
The optional parameters for rendering.
pageSettings
The optional page settings for rendering.

Return Value

An System.Web.Http.IHttpActionResult type object with content of exported file stream.
See Also

Reference

ReportController Class
ReportController Members