Web API Edition | ComponentOne
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.

In This Topic
    ExportReport_Get Method
    In This Topic
    Exports the specified report to the specified export filter with options and the specified page settings or/and parameters.
    Syntax
    'Declaration
     
    
    <HttpGetAttribute()>
    <PathRouteAttribute("{*reportPath}$report/export")>
    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

    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