Módulo Retorno

• Definição

• Configuração do módulo

  • Variáveis de Fluxo

    • Dados de origem

    • Resultado

Definição

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 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, além de obter um conjunto de dados, filtrar para que somente um subconjunto específico seja evocado.

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". Para manipulações de dados de menor complexidade, igualmente sem a necessidade de uma resposta externa, recomendamos o uso de uma SMOP.

Configuração do módulo Retorno

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.

Saiba sobre o Cabeçalho do Módulo aqui.

Variáveis de Fluxo

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.

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

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.

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