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.
• Handle errors gracefully, especially when combined with the Try/Catch activity.

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

Observação:

Currently, schema validation is not enforced, so if the data returned in the Response activity includes more or fewer properties than those defined in the output schema, the workflow does not fail.

Melhores práticas

• Always configure your Output schema in the Data manager before adding a Response activity. When you define the schema first, the system automatically suggests aligning your Response activity with it.
• Use a Response step when your calling party, such as Maestro or an agent, expects a response.
• You can skip adding a Response when you are building system-to-system integrations or an unattended automation.

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:
   • Marcar trabalho como falha— Ative esta opção para marcar todo o fluxo de trabalho como falha. Isso é útil para sinalizar explicitamente que um erro lógico ocorreu, mesmo que nenhuma exceção técnica tenha sido gerada.
   • Resposta—Use o Editor de expressão para definir um objeto JSON que contém as informações de resposta desejadas. Você também pode fornecer um valor fixo ou uma variável.
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:

• Wrap the retrieval steps inside a Try/Catch block.
• 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: