> For the complete documentation index, see [llms.txt](https://docs.rierino.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rierino.com/design/user-interface/uis/extended-scope/extra-data.md).

# Extra Data

Extra data configurations allow providing additional data contents to editors and widgets beyond what API mapping provides.

While in most cases it is possible to receive all required data through API mapping, in certain scenarios, it is useful to receive additional data for display purposes (such as retrieving data based on a currently selected value).

Extra data configurations can be performed at both editor and widget levels, using an array (allowing multiple extra data feeds) of the following properties for each entry:

* **URL:** API url to pull extra data from, required unless extra data is calculation from input data only.
* **Method:** Request method to pull data from the URL (defaults to GET).
* **Parameters:** "body", "url" or "query", defining where to send the parameters for the action.
* **Extra Body:** Extra json body to include in request (e.g. a filter value to pass on). Extra body is sent in body or query based on the parameters configuration.
* **Extra Headers:** Extra headers to include in request.
* **Input Pattern:** Json path or expression to apply on current data to create request body.
* **Output Pattern:** Json path or expression to apply on URL response.
* **Allow Blank:** Whether null data values should be allowed for URL requests (defaults to false).
* **Merge Path:** Json path to merge calculated data on full results (e.g. product).

An additional property is used above the array entries:

* **Extra Path:** Json path to merge all extra data on current record (e.g. extra).


---

# 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.rierino.com/design/user-interface/uis/extended-scope/extra-data.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.