ComponentOne Studio Web API Edition
Export

PDF Export services enables you to export your PDF documents to different file formats. The PDF document layout and style along with the data gets exported to the specified format.

PDF Export service uses Export API to enable end users to render and export a specified PDF document to a desired format. You can provide the PDF file path, exportFileName and exportOptions in the service URL. The client application sends an HTTP request to the service application for using Export API to export the PDF document to the supported formats.

[GET] Export Service Request Schema

To get the supported export formats for a PDF document through client, you need to use GET method. PDF document path and PDF document name are specified in the request URL. Your client application sends an HTTP request message to the service, as:

GET: http://<host>[:port]/api/pdf/{pdfpath}/$pdf/export?[exportFileName]&[exportoptions]

pdfpath - The full path of PDF file.

exportFileName - The exported file name.

exportOptions - IExportOptions


URL Parameters

The GET request URL for PDF Export service accepts PDF document pdfpath, file name, and exportOptions (supported formats) as parameters.

Response Messages

HTTP Status Code Reason
200 The exported file stream.
404 The pdf path does not exist.
406 The format name is not acceptable.

[POST] Export Service Request Schema

To render and export the PDF file to the specified export filter with options, you need to use POST method. PDF file path is specified in the request URL. Your client application sends an HTTP request message to the service, as:

POST: http://<host>[:port]/api/pdf/{pdfpath}/$pdf/export

Response Messages

HTTP Status Code Reason
200 The exported file stream.
404 The pdf path does not exist.
406 The format name is not acceptable.

For more information on PDF Services, see WebApiExplorer demo.

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback