Rest Trigger

Com o Rest Trigger, você pode executar o fluxo de integração por meio de uma chamada externa com um dos métodos HTTP.

O formulário de configuração contém duas seções: INFORMATION e REQUIREMENTS.

restTriggerScreen

Na seção INFORMATION, você visualizará os seguintes campos:

  • Name: contém o nome padrão do trigger. Este campo é editável e o nome não poderá ser usado mais de uma vez no mesmo fluxo de integração.

  • Method: campo para seleção do método HTTP a ser usado. Os métodos HTTP disponíveis são:

    • delete;

    • get;

    • head;

    • options;

    • patch;

    • post;

    • put.

Por padrão, o campo estará em branco.

  • Communication Type: campo para definir se a chamada será síncrona (SYNC) ou assíncrona (ASYNC). Por padrão, a opção SYNC estará selecionada.

Para uma chamada assíncrona, o sistema retornará uma resposta 202.

A seção REQUIREMENTS contém os componentes HEADER e QUERY para a realização do mapeamento dos dados de entrada:

HEADER
  • Key: campo para inserção dos parâmetros de Header:

    • alfanumérico;

    • permite os caracteres _, . e -;

    • limite de 60 caracteres.

QUERY
  • Key: campo para inserção dos parâmetros de Query:

    • alfanumérico;

    • permite os caracteres _, . e -;

    • limite de 60 caracteres.

Não é permitido cadastrar a mesma key mais de uma vez.

Para excluir uma key em qualquer um dos componentes, clique no ícone da lixeira à direita da key.

Para adicionar uma nova key, clique no ícone de + ao lado da lixeira.

Payload definition

Para definir a estrutura do payload de entrada, clique em PAYLOAD DEFINITION no canto superior direito da tela do Rest Trigger.

O mapeamento da estrutura do payload de entrada no componente Rest Trigger facilitará a utilização dos campos mapeados em outros componentes do fluxo de integração.

Na janela que abre, há duas colunas:

  • JSON SCHEMA: você deverá informar o JSON schema para definir a estrutura que será trafegada na entrada da requisição. Não há limite de caracteres. Para validar o formato dos dados e visualizá-los na coluna JSON STRUCTURE, clique no ícone de atualização à direita icone de atualizacao.

  • JSON STRUCTURE: somente leitura.

configurando payload

É permitido editar as definições do payload em qualquer etapa da criação do fluxo de integração.

Se você já criou um JSON schema, ao clicar em PAYLOAD DEFINITION, verá os dados já cadastrados.

Para excluir um atributo da definição de payload, exclua a linha correspondente na coluna JSON schema.

Para confirmar os dados, clique em CONFIRM.

Se o JSON schema não estiver no formato correto, você verá uma mensagem de que o JSON schema é inválido.

Para sair da janela sem salvar, clique em CANCEL.

Para mais informações sobre as especificações de um JSON schema e sobre como montar um arquivo de validação de acordo com as suas necessidades, acesse JSON SCHEMA (em inglês).

Após finalizar as definições do payload e retornar à tela de configuração do Rest Trigger, clique em SAVE para salvar os registros.

Para sair da tela sem salvar, clique em X.

Para excluir o trigger, selecione o respectivo ícone no canvas e clique na lixeira.

A exclusão do Rest Trigger desabilita a função TEST MODE.
Thanks for your feedback!
EDIT
How useful was this article to you?