Compartilhar via


Formulários cognito

O Cognito Forms permite que você crie facilmente formulários online avançados, como pesquisas, formulários de pedidos, formulários de registro e muito mais. De graça.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Standard Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Standard Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Standard Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte do Cognito Forms
URL https://www.cognitoforms.com/support
Email support@cognitoforms.com
Metadados do conector
Publicador Formulários cognito
Site https://www.cognitoforms.com
Política de Privacidade https://www.cognitoforms.com/legal/privacy
Categorias Produtividade; Colaboração

Formulários cognito

O Cognito Forms permite que você crie facilmente formulários online avançados, como pesquisas, formulários de pedidos, formulários de registro e muito mais. De graça. Consulte nossa documentação de suporte ou entre em contato conosco para obter ajuda com nosso conector público do Power Automate.

Publicador: Cognito Forms

Pré-requisitos

Uma assinatura paga é necessária.

Operações com suporte

Triggers

Os gatilhos serão enviados logo após a ocorrência do evento assinado.

NewEntry

Isso será disparado quando uma nova entrada for criada para o formulário especificado. A saída serão os dados de entrada, incluindo dados de arquivo e links temporários para arquivos, assinaturas e documentos de entrada.

Parâmetros:
  • form: o nome do formulário para o qual novos eventos de entrada serão assinados.

UpdateEntry

Isso será disparado quando uma entrada for atualizada para o formulário especificado. A saída serão os dados de entrada, incluindo dados de arquivo e links temporários para arquivos, assinaturas e documentos de entrada.

Parâmetros:
  • form: o nome do formulário para o qual os eventos de entrada atualizados serão assinados.

EntryDeleted

Isso será disparado quando uma entrada for excluída para o formulário especificado. A saída serão os dados de entrada, excluindo links.

Parâmetros:
  • form: o nome do formulário para o qual os eventos excluídos de entrada serão assinados.

Ações

CreateEntry

Essa ação criará uma entrada para o formulário especificado. A ação incluirá propriedades configuráveis para cada campo de entrada, excluindo alguns tipos de campo. A saída serão os dados de entrada.

Parâmetros:
  • form: o nome do formulário interno ou a ID

EditEntry

Essa ação atualizará uma entrada existente para o formulário especificado. A ação incluirá propriedades configuráveis para cada campo de entrada, excluindo alguns tipos de campo. Essa ação falhará se a entrada incluir um pedido pago ou se a entryId não existir. A saída será os dados de entrada atualizados.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • entryId: o número de entrada ou a ID de entrada para a entrada a ser atualizada

SetFormAvailability

Essa ação definirá as configurações de disponibilidade de limite do formulário. O start e end os parâmetros devem estar em branco para disponibilizar o formulário o tempo todo. A saída será as configurações de disponibilidade atualizadas.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • start: o datetime no qual o formulário deve ficar disponível.
  • end: o datetime no qual o formulário não deve mais estar disponível.
  • message: a mensagem que deve ser mostrada aos usuários que tentam acessar o formulário quando estiver fora do período de disponibilidade.

GetFile

Essa ação recuperará um arquivo do armazenamento. A saída será um objeto que contém os dados do arquivo, os metadados e um link temporário para o arquivo.

Parâmetros:
  • id: a ID do arquivo a ser recuperado.

GetDocument

Essa ação gerará e recuperará um documento de entrada usando o formulário, a entrada e o modelo especificados. A saída será um objeto que contém os dados do arquivo do documento, os metadados e um link temporário para o documento.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • entry: A ID de entrada ou o número de entrada da entrada para a qual o documento deve ser gerado
  • templateNumber: o número do modelo que deve ser usado para gerar o documento de entrada

GetEntry

Essa ação obterá uma entrada existente para o formulário especificado. Essa ação falhará se a entrada não existir. A saída serão os dados de entrada.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • entryId: o número de entrada ou a ID de entrada para a entrada a ser recuperada

DeleteEntry

Essa ação excluirá uma entrada existente para o formulário especificado. Essa ação falhará se a entrada não existir. Não haverá saída.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • entryId: o número de entrada ou a ID de entrada para a entrada a ser excluída

Operações Privadas

Essas operações são habilitadores para os gatilhos e ações públicos.

GetForms

Esta operação retornará uma lista de formulários como objetos que contêm o Id, InternalNamee Name. Quando usado para o form parâmetro para ações e gatilhos, o usuário deve ver o Name, mas o InternalName deve ser enviado para a API.

GetFormSchema

Essa operação retornará o esquema do formulário especificado. O input parâmetro deve ser verdadeiro para que as ações excluam as propriedades somente leitura e false para que os gatilhos incluam todas as propriedades. O includeLinks parâmetro deve ser verdadeiro para todas as ações e gatilhos, exceto para EntryDeleted.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • input: um booliano que indica se o esquema retornado deve excluir propriedades que não podem ser definidas. False por padrão.
  • includeLinks: um booliano que indica se as propriedades de link para arquivos, assinaturas e documentos devem ser incluídas no esquema. True por padrão.

CancelarsubscribeWebhook

Essa operação cancelará a assinatura do webhook especificado. O webhook não receberá mais eventos depois que todos os eventos na fila tiverem sido enviados.

Parâmetros:
  • id: a ID do webhook que deve ser desinscrita.
  • module: o módulo do webhook. Isso deve ser definido como "formulários", pois esse conector só dá suporte a esse módulo.

Obtendo credenciais

Um proprietário da organização deve fazer logon no Cognito Forms e autorizar a conexão.

Problemas conhecidos

None

Instruções de implantação

O Cognito Forms requer um conector válido Client id e Client secret um conector. Essas propriedades podem ser encontradas no cofre de chaves e devem ser definidas apenas nas configurações de autenticação do conector personalizado.

  1. Run:

     paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json
    
  2. Fazer logon no PowerAutomate

  3. Navegue até o novo conector

  4. Em "Segurança" atualize o Client id e Client secret

  5. Atualizar o conector

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Criar entrada

Cria uma nova entrada.

Definir a disponibilidade do formulário

Define a disponibilidade de um formulário.

Entrada de atualização

Atualiza uma entrada.

Excluir entrada

Excluir uma entrada.

Obter arquivo

Obtém um arquivo por id

Obter Documento

Obtém um documento

Obter entrada

Obtém uma entrada.

Criar entrada

Cria uma nova entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

Entry
entry True dynamic

A entrada a ser criada para o formulário

Retornos

As saídas desta operação são dinâmicas.

Definir a disponibilidade do formulário

Define a disponibilidade de um formulário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

Início da Disponibilidade
start date-time

Data de início da disponibilidade

Fim da Disponibilidade
end date-time

Data de término da disponibilidade

Mensagem não disponível
message string

Mensagem não disponível

Retornos

Informações de disponibilidade do formulário, como disponibilidade de início/término e mensagem não disponível.

Entrada de atualização

Atualiza uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de entrada
entryId True string

A ID de entrada

Entry
entry True dynamic

Os dados de entrada atualizados

Retornos

As saídas desta operação são dinâmicas.

Excluir entrada

Excluir uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de entrada
entryId True string

A ID de entrada

Retornos

As saídas desta operação são dinâmicas.

Obter arquivo

Obtém um arquivo por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do arquivo
id True string

O identificador exclusivo do arquivo

Retornos

Uma referência de arquivo que inclui dados de arquivo e metadados

Corpo
FileDataRef

Obter Documento

Obtém um documento

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de entrada
entry True string

A ID de entrada

Número do modelo
templateNumber True integer

O número do modelo

Retornos

Uma referência de arquivo que inclui dados de arquivo e metadados

Corpo
FileDataRef

Obter entrada

Obtém uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de entrada
entryId True string

A ID de entrada

Retornos

As saídas desta operação são dinâmicas.

Gatilhos

Quando uma entrada é atualizada

Dispara quando alguém atualiza uma entrada.

Quando uma entrada é excluída

Dispara quando alguém exclui uma entrada.

Quando uma nova entrada é criada

Dispara quando alguém cria uma nova entrada.

Quando uma entrada é atualizada

Dispara quando alguém atualiza uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
publisher True string

O nome do formulário

Retornos

As saídas desta operação são dinâmicas.

Quando uma entrada é excluída

Dispara quando alguém exclui uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
publisher True string

O nome do formulário

Retornos

As saídas desta operação são dinâmicas.

Quando uma nova entrada é criada

Dispara quando alguém cria uma nova entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
publisher True string

O nome do formulário

Retornos

As saídas desta operação são dinâmicas.

Definições

FileDataRef

Uma referência de arquivo que inclui dados de arquivo e metadados

Nome Caminho Tipo Description
ID do arquivo
Id string

A ID exclusiva do arquivo.

Nome do Arquivo
Name string

O nome do arquivo

Tipo de conteúdo do arquivo
ContentType string

O tipo de conteúdo do arquivo.

Tamanho do arquivo
Size integer

O tamanho do arquivo.

URL do Arquivo
File string

A URL do arquivo.

Conteúdo do arquivo
Content byte

O conteúdo do arquivo

FormAvailability

Informações de disponibilidade do formulário, como disponibilidade de início/término e mensagem não disponível.

Nome Caminho Tipo Description
Início da disponibilidade do formulário
availabilityStart date-time

Início da disponibilidade do formulário

Fim da disponibilidade do formulário
availabilityEnd date-time

Fim da disponibilidade do formulário

Mensagem não disponível
notAvailableMessage string

Mensagem não disponível