> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pdia-admin/9.3-administer/embed-and-extend-pentaho-functionality-cp/embed-pentaho-server-functionality-into-web-applications/report-designer-samples.md).

# Report Designer samples

The following samples show how to render Report Designer reports in various web applications.

## Execute a report from a HTML form (POSTing parameters)

This sample renders a Report Designer (PRPT) report by posting the report parameters to the report REST URL:

`http://localhost:8080/pentaho/api/repos/*<path>*/generatedContent`

The POST request contains all parameters the report expects, plus the additional rendering parameter **output-target**, which controls the rendering format (HTML, PDF, XLS, etc.)

The following output formats are supported:

| **Option**                                                                         | **Purpose**                                                                       |
| ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `table/html;page-mode=stream`                                                      | HTML as a single page, all report pagebreaks are ignored.                         |
| `table/html;page-mode=page`                                                        | HTML as a sequence of physical pages, manual and automatic pagebreaks are active. |
| `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;page-mode=flow` | Excel 2007 XLSX Workbook                                                          |
| `table/excel;page-mode=flow`                                                       | Excel 97 Workbook                                                                 |
| `table/csv;page-mode=stream`                                                       | CSV output                                                                        |
| `table/rtf;page-mode=flow`                                                         | Rich text format                                                                  |
| `pageable/pdf`                                                                     | PDF output                                                                        |
| `pageable/text`                                                                    | Plain text                                                                        |
| `pageable/xml`                                                                     | Pageable layouted XML                                                             |
| `table/xml`                                                                        | Table-XML output                                                                  |
| `pageable/X-AWT-Graphics;image-type=png`                                           | A single report page as PNG.                                                      |
| `mime-message/text/html`                                                           | MIME email with HTML as body text and all style and images as inline attachments. |

## Render a report in an IFRAME

This sample renders a PRPT report using a regular GET request, by populating an HTML IFRAME with the report REST URL:

`http://localhost:8080/pentaho/api/repos/*<path>*/generatedContent?*<parameters>*`

The request contains all parameters as part of the URL.

## Render report viewer with available parameters and executed report

The sample renders the **Pentaho Report Viewer IU** by populating an HTML IFRAME with the report REST URL:

`http://localhost:8080/pentaho/api/repos/**<path>**/viewer?**<parameters>**`

The request contains the initial report parameters as part of the URL.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pentaho.com/pdia-admin/9.3-administer/embed-and-extend-pentaho-functionality-cp/embed-pentaho-server-functionality-into-web-applications/report-designer-samples.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.