# Módulo Retorno

* [Definição](#definicao)
* [Configuração do módulo](#configuracao-do-modulo-retorno)
  * [Variáveis de Fluxo](#variaveis-de-fluxo)
    * [Dados de origem](#variaveis-de-fluxo)
    * [Resultado](#resultado)

### Definição <a href="#definicao" id="definicao"></a>

O módulo ferramental **"Retorno"**, módulo padrão para a utilização em qualquer fluxo, foi criado para a transformação de dados por meio de [JSONATA](https://jsonata.org/) e retornar uma resposta para uma requisição HTTP, facilitando assim a criação de operações complexas.

JSONata é uma linguagem leve, projetada para consultar e transformar estruturas de dados JSON.

O módulo **"Retorno"** é composto por uma única operação, que permite a manipulação de vários dados e a transformação destes dados no formato que desejamos. Este módulo inicializa sempre o parâmetro **data**, o que nos permite, como vimos em [Manipulação de Objetos](/skyone-studio/integracoes/operacoes-de-dados/manipulacao-de-objetos.md), além de obter um conjunto de dados, filtrar para que somente um subconjunto específico seja evocado.

{% hint style="info" %}
O **"Retorno"** é ideal para manipulações mais complexas de dados, que necessitem de uma resposta para uma requisição HTTP. Para manipular dados com uma resposta interna no fluxo, recomendamos o módulo [**"Transformação de Dados"**](/skyone-studio/integracoes/fluxos/modulos-ferramentais/modulo-transformacao-de-dados.md). Para manipulações de dados de menor complexidade, igualmente sem a necessidade de uma resposta externa, recomendamos o uso de uma [SMOP](/skyone-studio/integracoes/operacoes-de-dados/smop-pequenas-operacoes.md).
{% endhint %}

### Configuração do módulo Retorno <a href="#configuracao-do-modulo-retorno" id="configuracao-do-modulo-retorno"></a>

O módulo **"Retorno"** aparece na opção **Ferramentas** da edição de um fluxo. Após clicar para adicioná-lo, o modal de configuração será exibido.

<figure><img src="/files/wryJd5usSRVM3J9S3gyI" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
[Saiba sobre o Cabeçalho do Módulo aqui](/skyone-studio/integracoes/cabecalho-dos-modulos.md).&#x20;
{% endhint %}

#### Variáveis de Fluxo <a href="#variaveis-de-fluxo" id="variaveis-de-fluxo"></a>

Esta é a primeira parte da configuração do módulo **"Retorno"**. Aqui, é necessário fornecer um conjunto de dados para transformação no formato JSON e clicar em "**Validar"** para verificar se há algum erro e ter uma pré-visualização dos dados que serão transformados.

<figure><img src="/files/e3a8J8N02WpcoWpjJN5x" alt=""><figcaption></figcaption></figure>

**Dados de origem**

Adicione, arraste e escolha os campos necessários: **Chave**, **Valor** e **Tipo** (objeto, número, etc).

Também é possível usar o "**JSON Origem"**.

Após finalizar as configurações de variáveis de fluxo, clique em "**Avançar"**.

#### Resultado <a href="#resultado" id="resultado"></a>

Em "**Resultado"**, visualize a área de Dados de Entrada, JSON e JSONATA e manipule-os da maneira como desejar com o JSONATA. O botão "**Executar**" permite realizar teste sobre as variávis recém configuradas.

<figure><img src="/files/Kv9PttG2LTbhaxFVEt65" alt=""><figcaption></figcaption></figure>

Para finalizar a configuração do módulo, clique em "**Salvar**".


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.skyone.cloud/skyone-studio/integracoes/fluxos/modulos-ferramentais/modulo-retorno.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.