Formas Cognito

O Cognito Forms é um construtor de formulários online para recolher e gerir dados de submissão. Este conector permite que fluxos automáticos sejam ativados quando entradas são criadas, atualizadas ou eliminadas e fornece ações para criar, atualizar e recuperar entradas. Integre o Cognito Forms com outros serviços para encaminhar dados, processar ficheiros carregados e automatizar fluxos de trabalho empresariais.

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

Serviço	Class	Regiões
Estúdio Copiloto	Standard	Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões Azure Government - Regiões Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Standard	Todas as regiões Power Apps exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Standard	Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte a Formulários Cognito
URL	https://www.cognitoforms.com/support
Email	support@cognitoforms.com

Metadados do conector
Publisher	Cognito Forms, LLC
Sítio Web	https://www.cognitoforms.com
Política de Privacidade	https://www.cognitoforms.com/legal/privacy
Categorias	Produtividade; Colaboração

Formas Cognito

O Cognito Forms permite que você crie facilmente formulários on-line poderosos, como pesquisas, formulários de pedidos, formulários de registro e muito mais. De graça. Por favor, consulte a nossa documentação suporte ou contacte-nos para obter ajuda com o nosso conector de Power Automate público.

Publisher: Cognito Forms

Pré-requisitos

É necessária uma subscrição paga.

Operações suportadas

Acionadores

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

NovaEntrada

Isso será acionado 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 os novos eventos de entrada serão inscritos.

UpdateEntry

Isso será acionado 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 inscritos.

EntryDeleted

Isso será acionado quando uma entrada for excluída para o formulário especificado. A saída será 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 inscritos.

Ações

CreateEntry

Esta 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á os dados de entrada.

Parâmetros:

form: O nome do formulário interno ou Id

EditEntry

Esta 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. Esta ação falhará se a entrada incluir uma ordem paga ou se o entryId não existir. A saída será os dados de entrada atualizados.

Parâmetros:

form: O nome do formulário interno ou Id
entryId: O número de entrada ou ID de entrada para a entrada a ser atualizada

SetFormAvailability

Essa ação definirá as configurações de disponibilidade de limite do formulário. Os start parâmetros e end 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 Id
start: A data em que o formulário deve ficar disponível.
end: A data em que 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 fora do período de disponibilidade.

GetFile

Esta ação recuperará um arquivo do armazenamento. A saída será um objeto contendo os dados do arquivo, os metadados e um link temporário para o arquivo.

Parâmetros:

id: O 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 contendo 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 Id
entry: O 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

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

Parâmetros:

form: O nome do formulário interno ou Id
entryId: O número de entrada ou ID de entrada para a entrada a ser recuperada

DeleteEntry

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

Parâmetros:

form: O nome do formulário interno ou Id
entryId: O número de entrada ou ID da entrada para a entrada a ser excluída

ImportEntradas

Esta ação irá criar, atualizar ou eliminar entradas usando o conteúdo fornecido (.xlsx ou .csv). A saída será um objeto contendo o ID de importação e o estado.

Parâmetros:

form: O nome do formulário interno ou Id
File: O ficheiro (.xlsx ou .csv) que contém as entradas a importar
ImportMode: O modo para a importação (CreateNew, UpdateExisting ou SyncEntrries)
Email: O endereço de email para receber notificações de importação (opcional)
MatchEntriesUsing: Um substituto do ID de entrada (opcional)

GetImportStatus

Esta ação devolve o estado atual de uma importação e devolve o número de entradas bem-sucedidas e não bem-sucedidas. A saída será um objeto contendo o estado de importação, contagens e informações de erro, se aplicável.

Parâmetros:

form: O nome do formulário interno ou Id
importId: O ID da importação para verificar o estado

Upload File

Esta ação fará upload de um ficheiro para o Cognito Forms.

Parâmetros:

fileContent: Os dados binários do ficheiro
fileName: O nome do ficheiro

GetEntryViewEntries

Esta ação obtém todas as entradas para uma vista especificada. A saída será os dados de entrada com base na configuração da visualização.

Parâmetros:

form: O nome do formulário interno ou Id
viewId: O ID da vista
$count: Incluir a contagem total de entradas (opcional)
$select: Devolve a lista de IDs de entrada numa Vista quando $select=Id é especificado (opcional)

Operações Privadas

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

GetForms

Esta operação devolverá uma lista de formas como objetos que contêm os Id e Name. Quando usado para o form parâmetro para ações e gatilhos, o usuário deve ver o Name, mas o Id deve ser enviado para a API. Formulários arquivados não estão incluídos na resposta.

GetFormSchema

Esta operação retornará o esquema para o formulário especificado. O input parâmetro deve ser true para ações para excluir propriedades somente leitura e false para gatilhos para incluir todas as propriedades. O includeLinks parâmetro deve ser true para todas as ações e gatilhos, exceto para EntryDeleted.

Parâmetros:

form: O nome do formulário interno ou Id
input: Um booleano que indica se o esquema retornado deve excluir propriedades que não podem ser definidas. Falso por padrão.
includeLinks: Um booleano que indica se as propriedades de link para arquivos, assinaturas e documentos devem ser incluídas no esquema. True por padrão.

Cancelar inscriçãoWebhook

Esta operação cancelará a inscrição do webhook especificado. O webhook não receberá mais nenhum evento depois que todos os eventos atualmente enfileirados tiverem sido enviados.

Parâmetros:

id: O Id do webhook que deve ser cancelado.
module: O módulo do webhook. Isso deve ser definido como "formulários", pois este conector suporta apenas esse módulo.

Obtenção de credenciais

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

Problemas conhecidos

Nenhum

Instruções de implantação

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

Executar:

 paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json

Faça login no PowerAutomate
Navegue até o novo conector
Em "Segurança", atualize o Client id e Client secret
Atualizar o conector

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Carregar ficheiro	Carrega um ficheiro para ser usado em entradas de formulário.
Criar entrada	Cria uma nova entrada.
Definir disponibilidade do formulário	Define a disponibilidade de um formulário.
Entrada de atualização	Atualiza uma entrada.
Entradas de Importação	Cria, atualiza ou elimina entradas usando o conteúdo fornecido dos ficheiros.
Excluir entrada	Excluir uma entrada.
Obter documento	Obtém um documento
Obter entrada	Obtém uma entrada.
Obter Entradas de Formulário	Obtenha todas as entradas para uma vista especificada
Obter ficheiro	Recebe um ficheiro por identificação.
Obter status de importação	Recebe o estado atual de uma importação e devolve o número de entradas bem-sucedidas e não bem-sucedidas.

Carregar ficheiro

ID da Operação:: UploadFile

Carrega um ficheiro para ser usado em entradas de formulário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
File	File	True	file	O ficheiro a carregar.

Devoluções

Name	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 de arquivo	ContentType	string	O tipo de conteúdo do arquivo.
Tamanho do Ficheiro	Size	integer	O tamanho do arquivo em bytes.

Criar entrada

ID da Operação:: CreateEntry

Cria uma nova entrada.

Parâmetros

Name	Chave	Necessá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

Devoluções

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

Definir disponibilidade do formulário

ID da Operação:: SetFormAvailability

Define a disponibilidade de um formulário.

Parâmetros

Name	Chave	Necessá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 fim da disponibilidade
Mensagem não disponível	message		string	Mensagem não disponível

Devoluções

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

Body: FormAvailability

Entrada de atualização

ID da Operação:: EditEntry

Atualiza uma entrada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	form	True	string	O nome do formulário
ID de entrada	entryId	True	string	O ID de entrada
Entry	entry	True	dynamic	Os dados de entrada atualizados

Devoluções

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

Entradas de Importação

ID da Operação:: ImportEntries

Cria, atualiza ou elimina entradas usando o conteúdo fornecido dos ficheiros.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	form	True	string	O nome do formulário
Ficheiro de importação	File	True	file	O ficheiro (.xlsx ou .csv) contém as entradas a importar.
Modo de importação	ImportMode	True	string	O modo para a importação
E-mail de notificação	Email		email	O endereço de email para receber notificações de importação
Campo de Jogo	MatchEntriesUsing		string	Um substituto do ID de entrada

Devoluções

Name	Caminho	Tipo	Description
Id	Id	string	O ID da importação
Situação	Status	string	O estatuto da importação
Mensagem de Erro	ErrorMessage	string	Uma mensagem a descrever porque é que a importação falhou

Excluir entrada

ID da Operação:: DeleteEntry

Excluir uma entrada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	form	True	string	O nome do formulário
ID de entrada	entryId	True	string	O ID de entrada

Obter documento

ID da Operação:: GetDocument

Obtém um documento

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	form	True	string	O nome do formulário
ID de entrada	entry	True	string	O ID de entrada
Número do modelo	templateNumber	True	integer	O número do modelo

Devoluções

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

Body: FileDataRef

Obter entrada

ID da Operação:: GetEntry

Obtém uma entrada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	form	True	string	O nome do formulário
ID de entrada	entryId	True	string	O ID de entrada

Devoluções

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

Obter Entradas de Formulário

ID da Operação:: GetEntryViewEntries

Obtenha todas as entradas para uma vista especificada

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	form	True	string	O nome da Forma
ID da Vista	viewId	True	string	O ID da vista
Incluir Conde	$count		string	Incluir o total de participações
Identificações selecionadas	$select		string	Devolve a lista de IDs de entrada numa Vista quando $select=ID é especificado

Devoluções

response: object

Obter ficheiro

ID da Operação:: GetFile

Recebe um ficheiro por identificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do arquivo	id	True	string	O identificador exclusivo do ficheiro

Devoluções

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

Body: FileDataRef

Obter status de importação

ID da Operação:: GetImportStatus

Recebe o estado atual de uma importação e devolve o número de entradas bem-sucedidas e não bem-sucedidas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	form	True	string	O nome da Forma
ID de importação	importId	True	string	O ID de Importação

Devoluções

Name	Caminho	Tipo	Description
Id	Id	string	O ID da importação
Situação	Status	string	O estatuto da importação
Mensagem de Erro	ErrorMessage	string	Uma mensagem a descrever porque é que a importação falhou
Candidaturas Bem-sucedidas	SuccessfulEntries	integer	Número de entradas importadas com sucesso
Candidaturas não bem-sucedidas	UnsuccessfulEntries	integer	O número de entradas que não foram importadas
Total de Entradas	TotalEntries	integer	O número total de entradas na importação
ImportLink	ImportLink	string	O link para a página de inscrições para descarregar o ficheiro anotado

Acionadores

Quando uma entrada é atualizada	Aciona quando alguém atualiza uma entrada.
Quando uma entrada é excluída	Aciona quando alguém exclui uma entrada.
Quando uma nova entrada é criada	Aciona quando alguém cria uma nova entrada.

Quando uma entrada é atualizada

ID da Operação:: UpdateEntry

Aciona quando alguém atualiza uma entrada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	publisher	True	string	O nome do formulário

Devoluções

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

Quando uma entrada é excluída

ID da Operação:: EntryDeleted

Aciona quando alguém exclui uma entrada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	publisher	True	string	O nome do formulário

Devoluções

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

Quando uma nova entrada é criada

ID da Operação:: NewEntry

Aciona quando alguém cria uma nova entrada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Formulário	publisher	True	string	O nome do formulário

Devoluções

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

Name	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 de arquivo	ContentType	string	O tipo de conteúdo do arquivo.
Tamanho do Ficheiro	Size	integer	O tamanho do arquivo.
URL do ficheiro	File	string	O URL do ficheiro.
Conteúdo do Ficheiro	Content	byte	O conteúdo do ficheiro

Disponibilidade do formulário

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

Name	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

objecto

Este é o tipo 'objeto'.