Resposta

A atividade Response encerra um fluxo de trabalho de API e envia uma resposta estruturada ao solicitante. A resposta geralmente inclui um status e dados adicionais.

Use a atividade Response para:

• Sempre retorne o status e detalhes de resposta corretos.
• Finalize os fluxos de trabalho com um resultado claro e estruturado.
• Lide com erros graciosamente, especialmente quando combinados com a atividade Try-Catch .

A atividade Response deve ser a etapa final em um fluxo de trabalho, para garantir que o processo forneça as informações pretendidas.

Importante: se você não adicionar uma atividade Response , o fluxo de trabalho retornará a resposta da última solicitação executada. Se ocorrer um erro, o fluxo de trabalho retornará os detalhes do erro.

Usando a atividade Response

Para adicionar uma atividade Response 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 Resposta.
3. No painel Propriedades , configure os seguintes campos:
   • Tipo
     • Selecione Sucesso quando o fluxo de trabalho for concluído com sucesso e retornar a resposta esperada.
     • Selecione Falha quando o fluxo de trabalho encontrar um erro ou não tiver os dados necessários para uma resposta bem-sucedida.
   • Detalhes—Use o Editor de expressão para definir um objeto JSON que contém as informações de resposta desejadas.
4. Salvar a configuração.

Exemplo de atividade de resposta

O exemplo a seguir recupera um trabalho do Workday e agrega detalhes sobre seu gerente e relatórios diretos.

A imagem a seguir exibe o fluxo de trabalho de exemplo:

A resposta de falha

O fluxo de trabalho retorna um status de Falha com uma mensagem de erro se qualquer etapa de recuperação falhar.

Para alcançar isto:

• Envolva as etapas de recuperação em um bloco Try-Catch .
• Se ocorrer um erro, a etapa Error Response no fluxo Catch retorna uma resposta de falha estruturada.

Configure a resposta com os seguintes detalhes:

• Tipo— Falha
• Detalhes—Abra o Editor de expressão e escreva o seguinte:

  ({
      "error_message": $context.outputs.Try_Catch_3.error.title,
      "status": $context.outputs.Try_Catch_3.error.status
  })

  Aqui, $context.outputs.Try_Catch_3.error fornece uma saída de erro estruturada da atividade Try-Catch . Quando o fluxo Tentar encontra um erro durante a execução, o fluxo de trabalho retorna a seguinte saída:
  

A resposta de êxito

O fluxo de trabalho retorna um status de Sucesso com as informações agregadas do trabalho. A atividade Search Workers by Name or ID retorna uma matriz, mesmo quando há apenas uma correspondência. Lá, usamos uma atividade For Each para processar cada resultado e, em seguida, consolidamos os dados usando uma atividade Script .

Configure a resposta com os seguintes detalhes:

• Tipo— Sucesso
• Detalhes—Abra o Editor de expressão e escreva o seguinte:

  ({
      "workers": $context.outputs.For_Each_2.results
  })

  Aqui, workers contém a saída agregada da etapa Script do loop For Each . O fluxo de trabalho retorna a seguinte saída: