For Each

A atividade For Each itera em matrizes e executa um conjunto definido de etapas para cada elemento de matriz. Use a atividade For each para lidar com respostas de API que contêm matrizes de objetos, como listas de usuários, pedidos ou registros que exigem processamento individual.

Como agregar dados em um array

Um caso de uso comum para a atividade For Each é agregar dados de várias chamadas de API em uma matriz estruturada usando a atividade Script .

A atividade For Each coleta automaticamente a saída da última atividade dentro de seu fluxo Corpo e compila-a em um array disponível em sua própria saída.

Como usar a atividade For Each

Para adicionar uma atividade For each ao seu fluxo de trabalho:

1. Em sua tela de designer de fluxo de trabalho de API, selecione o ícone de mais (+). O menu Adicionar atividade aparece.
2. Selecione Loop e, em seguida, ForEach.
3. No painel Propriedades , configure os seguintes campos:
   • Em—Use o Editor de expressão para especificar a matriz para iteração. Normalmente, essa matriz vem de uma resposta de API anterior.
   • Nome do item— Atribua um nome de referência para os elementos do array (o padrão é currentItem). Use essa referência para acessar cada item durante a iteração.
   • Acumular resultado— Ative-o para coletar a saída de cada iteração em uma única matriz de resultados, que você poderá acessar posteriormente no fluxo de trabalho.
4. No Corpo do loop ForEach , adicione as atividades para processar os itens de array.
5. Adicione atividades às ramificações Then e Else conforme a necessidade.
6. Teste o fluxo de trabalho para executar a atividade e gerar campos de saída para uso posterior.

Exemplo de atividade For Each

O exemplo a seguir itera sobre uma matriz de objetos de funcionários, combina o nome e o sobrenome de cada funcionário e retorna os resultados agregados em uma resposta estruturada.

Abra a janela Configuração de depuração , cole e salve a seguinte sintaxe JSON:

{
    "employees": [
        {
            "first_name": "Bobbie",
            "last_name": "Draper",
            "position": "administration",
            "email": "[e-mail]"
        },
                {
            "first_name": "James",
            "last_name": "Holden",
            "position": "manager",
            "email": "[e-mail]"
        }
    ]
}

1. Na tela do designer do fluxo de trabalho da API, adicione uma atividade For Each .
2. Configure os campos For Each da seguinte forma:
   • Em—Use o Editor de expressão para fazer referência à matriz employees da configuração de execução:

     $workflow.input.employees

   • Nome do item— Atribua um nome de referência para os elementos do array (o padrão é currentItem). Use essa referência para acessar cada item durante a iteração.
3. No Corpo do loop For Each , adicione uma atividade Script .
4. Para a atividade Script , use Editor de expressão para criar um JSON que combine as propriedades first_name e last_name em um objeto:

   return {
       "name": $currentItem.first_name + " " + $currentItem.last_name
   }

5. Salvar a configuração.
6. No final do fluxo de trabalho, adicione uma atividade Response .
7. Configure a resposta da seguinte forma:
   • Tipo— Sucesso
   • Detalhes—Abra o Editor de expressão e escreva o seguinte:

     $context.outputs.For_Each_2

   Essa etapa adiciona uma validação no início do fluxo de trabalho para confirmar que existe uma transação válida antes do processamento.
8. Teste o fluxo de trabalho para executar a atividade.
9. Verifique o painel Saída para revisar a resposta.