Use o tipo de solicitação de dados de formulário para adicionar vários parâmetros ao corpo da solicitação.

Ações

As seguintes ações de parâmetro estão habilitadas:

Adicionar
Para adicionar parâmetros ao corpo da solicitação.
Clique no ícone Adicionar para adicionar um parâmetro. O número de parâmetros exibido no título da tabela Parâmetros é atualizado automaticamente.
Editar
Para editar os parâmetros existentes que estão disponíveis no corpo da solicitação.
Na tabela Parâmetros, passe o cursor sobre o ícone de reticências verticais do parâmetro que você deseja editar e, em seguida, clique no ícone Editar. Você pode editar a Chave, o Tipo de chave e os valores dos parâmetros no modal Editar parâmetro.
Excluir
Para excluir os parâmetros que estão disponíveis no corpo da solicitação.
Faça uma das seguintes ações para excluir parâmetros:
  • clique na caixa de seleção Selecionar tudo no cabeçalho da tabela e, em seguida, clique no ícone Excluir que está disponível acima da tabela para excluir vários parâmetros.
  • Passe o cursor sobre o menu de reticências verticais de cada parâmetro e, em seguida, clique no ícone Excluir para excluir o parâmetro individualmente.

Tabela de parâmetros

Visualize os seguintes detalhes do parâmetro na tabela.

ColunaDescrição
Chave Exibe a chave do parâmetro. O usuário do pacote não pode visualizar a chave no Editor de bot ou no editor de Tarefa de API. A chave é enviada como parte do cabeçalho.
Tipo de chave Mostra o tipo de dados do formulário. Determina como os dados são interpretados e tratados.
  • Texto: Se o tipo de chave for uma entrada de texto simples. O conteúdo é tratado como texto simples (texto/simples). Este tipo de chave é adequado para dados como nomes, endereços ou descrições.
  • Arquivo: Se o tipo de chave for um upload de arquivo binário. O conteúdo são os dados brutos do próprio arquivo carregado. Este tipo de chave é usado para fazer upload de documentos, imagens ou outros dados binários.
    Nota: O campo de tipo de arquivo é sempre definido pelos usuários, que podem fazer upload de arquivos através do Editor de bot.
Valor Exibe o valor do parâmetro. O usuário do pacote pode visualizar e atualizar esse valor no Editor de bot ou no editor de Tarefa de API.
O valor é fornecido pelo usuário Exibe o status do valor.
  • Sim: Se o valor é fornecido pelo usuário. O usuário do pacote precisa inserir um valor apropriado ao configurar esse parâmetro no Editor de bot ou no editor de Tarefa de API.
  • Não: Se o valor está codificado. O usuário do pacote não pode visualizar esse valor no Editor de bot ou no editor de Tarefa de API. Este valor é enviado como parte do cabeçalho.
Rótulo Exibe o rótulo para valores Fornecidos pelo usuário. O usuário do pacote pode visualizar o rótulo do parâmetro no Editor de bot ou no editor de Tarefa de API.
Descrição Exibe a descrição do parâmetro. O usuário do pacote pode visualizar a descrição do parâmetro no Editor de bot ou no editor de Tarefa de API.

Adicionar parâmetros ao corpo da solicitação

Siga estas etapas para adicionar um parâmetro ao corpo da solicitação de dados do formulário:

  1. clique na guia Corpo da solicitação dentro do painel Configuração.
  2. Selecione Dados do formulário na lista suspensa Tipo.
  3. Clique em Adicionar parâmetro ou no ícone de adição (+) na parte superior da tabela para adicionar um parâmetro.
  4. No modal Adicionar parâmetro, faça o seguinte.
    1. Chave: Insira um nome de chave apropriado. O nome da chave não é exibido para o usuário do pacote no Editor de bot ou no editor de Tarefa de API. Esse nome é enviado como parte do cabeçalho.
    2. Tipo de chave: Selecione o tipo de chave apropriado na lista suspensa.
    3. Selecione uma das seguintes opções na seção O valor será:
      Tipo Descrição
      Codificado Insira um valor codificado para o parâmetro. O usuário do pacote não pode visualizar esse valor no Editor de bot ou no editor de Tarefa de API. Este valor é enviado como parte do cabeçalho.
      Fornecido pelo usuário
      1. Tipo de entrada de valor: Habilite esta caixa de seleção para proteger o tipo de entrada de valor. Ao selecionar seguro, você pode inserir o parâmetro por meio de uma credencial, variável ou string insegura.
      2. Este campo é obrigatório?: Selecione Não ou Sim dependendo dos requisitos do parâmetro.
      3. Valor (opcional): Insira um valor. O usuário do pacote pode visualizar e atualizar esse valor no Editor de bot ou no editor de Tarefa de API.
      4. Rótulo: Insira um rótulo para o parâmetro. O usuário do pacote pode visualizar o rótulo do parâmetro no Editor de bot ou no editor de Tarefa de API.
      5. Descrição (opcional): Digite uma descrição para o parâmetro. O usuário do pacote pode visualizar a descrição do parâmetro no Editor de bot ou no editor de Tarefa de API. A descrição aparece como texto de ajuda no editor.
  5. Clique em Adicionar para adicionar o parâmetro ao corpo da solicitação.

    O novo parâmetro é exibido na tabela Parâmetros.

Repita as etapas para adicionar mais parâmetros ao corpo da solicitação.