Parametrizações
A sintaxe utilizada pela Fluid para criação/parametrização dos fluxos é simples e intuitiva. Para acesso a dados, seja do evento disparado para executar o fluxo ou para acessar os dados de um passo anterior, veja a seguir:
Para acessar tanto o JSON do body/payload de entrada do disparo do fluxo quanto as demais informações, utilize o .input:
- .input.bodyé usado para acessar o JSON do payload de entrada.
- .input.headers
- .input.query_params
Para acessar os dados resultantes da execução de um passo do fluxo, utilize a sintaxe .steps.<nome_do_passo>:
- Para acessar o resultado de um passo específico, utilize .steps.<nome_do_passo>.body
- Para headers resultantes de um passo, use .steps.<nome_do_passo>.headers
- Para o código (ex: HTTP Status Code) resultantes de um passo, use .steps.<nome_do_passo>.code
Considere um exemplo prático onde um fluxo é disparado via Gateway Fluid com a seguinte URL e JSON de entrada (payload):
Considere que um passo chamado passo_1 tenha gerado o seguinte resultado:
Na última versão 3.0, a sintaxe visa refletir a origem dos dados, utilizando .inputpara acessar os dados do payload de entrada e .steps para acessar os resultados dos passos.
A sintaxe para recuperar o campo payload_campo_1 do body do webhook/evento de entrada/disparo do fluxo é:
É possível acessar os headers utilizando .input.headers e os query parameters utilizando .input.query_params.
Exemplo para acessar os headers:
Ou para acessar diretamente um header específico:
Caso o header (ou nome do passo, query param, etc) contenha algum caractere especial como hífen -, acesse com a seguinte sintaxe:
Exemplo para acessar os query parameters:
Ou acessar um parâmetro específico:
Para acessar o body do resultado de um passo adotamos a sintaxe com .steps.<nome_do_passo>.body:
Para acessar um resultado específico (campo_x) dentro do resultado do passo_1, utilize:
Da mesma forma, é possível utilizar os dados para ter acesso aos headers utilizando .steps.<nome_do_passo>.headers e os query parameters utilizando .steps.<nome_do_passo>.query_params em um passo.
Exemplo para acessar os headers de um passo:
Ou:
Exemplo para acessar os query parameters:
Ou:
Para os usuários que já criaram fluxos utilizando a antiga sintaxe com .state, siga o guia de migração documentado em: Migração de sintaxe v2 para v3
Avançado
De/para
Rules
Template