Web API Edition | ComponentOne
Services / Report Services / Report Instances / Supported Formats
In This Topic
    Supported Formats
    In This Topic

    Report instance helps you to fetch all the supported formats for your report and gets a specific export format with the specified format name supported by the report. You can create a client application to send an HTTP request to the service application for using the report services.

    [GET] SupportedFormats Service Request Schema

    To get all the supported export formats, you need to use GET method. Report full path and instance id of executing report is specified in the request URL, as follows:

    GET: http://<host>[:port]/api/report/{folder path}/{report name}$instances/{instance id}/supportedformats

    Example URL
    Copy Code 
    https://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/supportedformats

    Parameters

    Parameter Description
    Report Full Path Specify the full path of the executing report.
    For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters
    Instance Id Specify the instance id of the executing report.

    Response Messages

    HTTP Status Code Reason
    200 JSON string contains a collection of IExportDescription.
    404 The report path or instance id does not exist.

    Back to Top

    [GET] SupportedFormats Service Request Schema

    To get the export format with a specific name supported by the report instance with the specified instance id, you need to use GET method. Report full path and instance id of executing report is specified in the request URL, as follows:

    GET: http://<host>[:port]/api/report/{folder path}/{report name}$instances/{instance id}/supportedformats/{format name}

    Example URL
    Copy Code 
    https://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/supportedformats/html

    Parameters

    Parameter Description
    Report Full Path Specify the full path of the executing report.
    For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters
    Instance Id Specify the instance id of the executing report.
    Supported Format Name Specify the supported format name. For example: html

    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.

    For more information about Report Instances. see WebApiExplorer Demo.