ComponentOne Studio Web API Edition
Supported Formats

Supported Format uses SupportedFormats API to enable end users to get the supported export formats for a report. Your client application sends an HTTP request to the service application for using SupportedFormats API to obtain the information about the supported export formats for a report.

Supported Formats Service Request Schema

To get the supported export formats for a report through client, you need to use GET method. Report file path and report name are specified in the request URL, as:

GET: http://<host>[:port]/api/report/{reportpath}/$report/supportedformats

The following illustration depicts a request URL with parameters to load a report from storage.

URL Parameters

Supported Formats URL primarily accepts Report Path as parameter. You need to specify the report file path in the Request Url. For more information on Report Services, see WebApiExplorer demo.

Response Messages

HTTP Status Code Reason
200 Json string contains a collection of IExportDescription.
404 The report path or format name does not exist.

Supported Format Service Request Schema

To get the supported export format for the specified report, you need to use the GET method. Report file path and report name are specified in the request URL, as:

GET:http://<host>[:port]/api/report/{reportpath}/$report/supportedformats/{formatname}

URL Parameters

Supported format service URL accepts two parameters Report Path and Format Name. You need to specify the report file name and the format name in the Request Url.

Response Messages

HTTP Status Code Reason
200 Json string contains IExportDescription type object.
404 The report path does not exist.

For more information on Report Services, see WebApiExplorer demo.

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback