Формы Cognito

Cognito Forms — это построитель онлайн-форм для сбора и управления данными о отправке. Этот соединитель позволяет автоматическим потокам активироваться при создании, обновлении или удалении записей и выполнении действий по созданию, обновлению и извлечению записей. Интеграция Cognitiveto Forms с другими службами для маршрутизации данных, обработки отправленных файлов и автоматизации бизнес-рабочих процессов.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Стандарт Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     - Azure для государственных организаций регионы
     - Azure регионы Китая
     - Министерство обороны США (DoD)
Power Apps Стандарт Все регионы Power Apps кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Стандарт Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Поддержка форм Cognito
URL https://www.cognitoforms.com/support
Адрес электронной почты support@cognitoforms.com
Метаданные соединителя
Publisher Cognito Forms, LLC
Website https://www.cognitoforms.com
Privacy Policy (Политика конфиденциальности) https://www.cognitoforms.com/legal/privacy
Категории Продуктивность; Сотрудничество

Формы Cognito

Cognito Forms позволяет легко создавать мощные онлайн-формы, такие как опросы, формы заказа, формы регистрации и многое другое. Бесплатно. Ознакомьтесь с нашей документацией support или contact us для справки с нашим общедоступным соединителем Power Automate.

Publisher: Когнитивные формы

Предпосылки

Требуется платная подписка.

Поддерживаемые операции

Triggers

Триггеры будут отправляться вскоре после возникновения события подписки.

NewEntry

Это будет активировано при создании новой записи для указанной формы. Выходные данные будут входными данными, включая данные файла и временные ссылки на файлы, подписи и документы записи.

Параметры:
  • form: имя формы, для которой будут подписаны новые события входа.

UpdateEntry

Это будет активировано при обновлении записи для указанной формы. Выходные данные будут входными данными, включая данные файла и временные ссылки на файлы, подписи и документы записи.

Параметры:
  • form: имя формы, для которой будут подписаны обновленные события записи.

EntryDeleted

Это будет активировано при удалении записи для указанной формы. Выходные данные будут данными записи, за исключением ссылок.

Параметры:
  • form: имя формы, для которой будут подписаны удаленные события записи.

Действия

CreateEntry

Это действие создаст запись для указанной формы. Действие будет содержать свойства settable для каждого поля записи, за исключением некоторых типов полей. Выходные данные будут данными записи.

Параметры:
  • form: имя или идентификатор внутренней формы

EditEntry

Это действие обновит существующую запись для указанной формы. Действие будет содержать свойства settable для каждого поля записи, за исключением некоторых типов полей. Это действие завершится ошибкой, если запись содержит платный заказ или идентификатор записи не существует. Выходные данные будут обновленными данными записи.

Параметры:
  • form: имя или идентификатор внутренней формы
  • entryId: номер записи или идентификатор записи для обновляемой записи

SetFormAvailability

Это действие установит параметры ограничения доступности формы. start Параметры end должны быть пустыми, чтобы сделать форму доступной все время. Выходные данные будут обновленными параметрами доступности.

Параметры:
  • form: имя или идентификатор внутренней формы
  • start: дата и время, в котором должна стать доступна форма.
  • end: дата и время, в котором форма больше не должна быть доступна.
  • message: сообщение, которое должно отображаться пользователям, которые пытаются получить доступ к форме за пределами периода доступности.

GetFile

Это действие извлекает файл из хранилища. Выходные данные — это объект, содержащий данные файла, метаданные и временную ссылку на файл.

Параметры:
  • id: идентификатор файла для извлекаемого файла.

GetDocument

Это действие создает и извлекает документ записи с помощью указанной формы, записи и шаблона. Выходные данные — это объект, содержащий данные файла документа, метаданные и временную ссылку на документ.

Параметры:
  • form: имя или идентификатор внутренней формы
  • entry: идентификатор записи или номер записи, для которой должен быть создан документ.
  • templateNumber: число шаблонов, которые должны использоваться для создания документа записи

GetEntry

Это действие получит существующую запись для указанной формы. Это действие завершится ошибкой, если запись не существует. Выходные данные будут данными записи.

Параметры:
  • form: имя или идентификатор внутренней формы
  • entryId: номер записи или идентификатор записи для извлекаемой записи

DeleteEntry

Это действие приведет к удалению существующей записи для указанной формы. Это действие завершится ошибкой, если запись не существует. Выходные данные не будут.

Параметры:
  • form: имя или идентификатор внутренней формы
  • entryId: номер записи или идентификатор записи для удаления записи

ImportEntries

Это действие создает, обновляет или удаляет записи с помощью предоставленного содержимого файла (.xlsx или .csv). Выходные данные будут объектом, содержащим идентификатор импорта и состояние.

Параметры:
  • form: имя или идентификатор внутренней формы
  • File: файл (.xlsx или .csv), содержащий записи для импорта
  • ImportMode: режим импорта (CreateNew, UpdateExisting или SyncEntries)
  • Email: адрес электронной почты для получения уведомлений о импорте (необязательно)
  • MatchEntriesUsing: замена идентификатора записи (необязательно)

GetImportStatus

Это действие получит текущее состояние импорта и возвращает количество успешных и неудачных записей. Выходные данные будут объектом, содержащим состояние импорта, счетчики и сведения об ошибке, если это применимо.

Параметры:
  • form: имя или идентификатор внутренней формы
  • importId: идентификатор импорта для проверки состояния

UploadFile

Это действие отправит файл в Cognito Forms.

Параметры:
  • fileContent: двоичные данные файла
  • fileName: имя файла

GetEntryViewEntries

Это действие получит все записи для указанного представления. Выходные данные будут входными данными на основе конфигурации представления.

Параметры:
  • form: имя или идентификатор внутренней формы
  • viewId: идентификатор представления
  • $count: включение общего количества записей (необязательно)
  • $select: возвращает список идентификаторов записей в представлении при указании $select=Id (необязательно)

Частные операции

Эти операции являются включениями для общедоступных триггеров и действий.

GetForms

Эта операция возвращает список форм в виде объектов, содержащих Id и Name. При использовании параметра для form действий и триггеров пользователь должен увидеть Nameэтот параметр, но Id его следует отправить в API. Архивные формы не включены в ответ.

GetFormSchema

Эта операция вернет схему для указанной формы. Параметр input должен иметь значение true для действий, чтобы исключить свойства только для чтения и false для триггеров, чтобы включить все свойства. Параметр includeLinks должен иметь значение true для всех действий и триггеров, за исключением EntryDeleted.

Параметры:
  • form: имя или идентификатор внутренней формы
  • input: логическое значение, указывающее, должна ли возвращаемая схема исключить свойства, которые нельзя задать. Значение по умолчанию — ложь.
  • includeLinks: логическое значение, указывающее, должны ли свойства ссылок для файлов, подписей и документов быть включены в схему. Значение true по умолчанию.

Отмена подпискиWebhook

Эта операция отменит подписку указанного веб-перехватчика. Веб-перехватчик больше не получит никаких событий после отправки всех текущих событий очереди.

Параметры:
  • id: Идентификатор веб-перехватчика, который должен быть отменен.
  • module: модуль веб-перехватчика. Для этого соединителя должно быть задано значение forms, так как этот соединитель поддерживает только этот модуль.

Получение учетных данных

Владелец организации должен войти в Cognito Forms и авторизовать подключение.

Известные проблемы

None

Инструкции по развертыванию

Cognito Forms требует допустимого Client id и Client secret создания соединителя. Эти свойства можно найти в хранилище ключей и должны быть заданы только в параметрах проверки подлинности пользовательского соединителя.

  1. Запуск:

     paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json
    
  2. Вход в PowerAutomate

  3. Перейдите к новому соединителю

  4. В разделе "Безопасность" обновите Client id и Client secret

  5. Обновление соединителя

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Импорт записей

Создает, обновляет или удаляет записи с помощью предоставленного содержимого файла.

Настройка доступности форм

Задает доступность формы.

Обновление записи

Обновляет запись.

Отправка файла

Отправляет файл, который будет использоваться в записях формы.

Получение документа

Возвращает документ

Получение записей формы

Получение всех записей для указанного представления

Получение записи

Возвращает запись.

Получение состояния импорта

Возвращает текущее состояние импорта и возвращает количество успешных и неудачных записей.

Получение файла

Возвращает файл по идентификатору.

Создание записи

Создает новую запись.

Удаление записи

Удаление записи.

Импорт записей

Создает, обновляет или удаляет записи с помощью предоставленного содержимого файла.

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Импорт файла
File True file

Файл (.xlsx или .csv), содержащий записи для импорта.

Режим импорта
ImportMode True string

Режим импорта

Уведомление по электронной почте
Email email

Адрес электронной почты для получения уведомлений об импорте

Поле сопоставления
MatchEntriesUsing string

Замена идентификатора записи

Возвращаемое значение

Имя Путь Тип Описание
Id
Id string

Идентификатор импорта

Статус
Status string

Состояние импорта

Сообщение об ошибке
ErrorMessage string

Сообщение, описывающее, почему сбой импорта

Настройка доступности форм

Задает доступность формы.

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Запуск доступности
start date-time

Дата начала доступности

Окончание доступности
end date-time

Дата окончания доступности

Недоступное сообщение
message string

Недоступное сообщение

Возвращаемое значение

Сведения о доступности форм, такие как начальная или конечная доступность и недоступное сообщение.

Тело
FormAvailability

Обновление записи

Обновляет запись.

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Идентификатор записи
entryId True string

Идентификатор записи

Entry
entry True dynamic

Обновленные данные записи

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Отправка файла

Отправляет файл, который будет использоваться в записях формы.

Параметры

Имя Ключ Обязательно Тип Описание
File
File True file

Файл для отправки.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор файла
Id string

Уникальный идентификатор файла.

Имя файла
Name string

Имя файла

Тип контента файла
ContentType string

Тип контента файла.

Размер файла
Size integer

Размер файла в байтах.

Получение документа

Возвращает документ

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Идентификатор записи
entry True string

Идентификатор записи

Номер шаблона
templateNumber True integer

Номер шаблона

Возвращаемое значение

Ссылка на файл, содержащая данные и метаданные файлов

Тело
FileDataRef

Получение записей формы

Получение всех записей для указанного представления

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Код представления
viewId True string

Идентификатор представления

Включение счетчика
$count string

Включение общего количества записей

Выбор идентификаторов
$select string

Возвращает список идентификаторов записей в представлении при указании $select=Id

Возвращаемое значение

response
object

Получение записи

Возвращает запись.

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Идентификатор записи
entryId True string

Идентификатор записи

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение состояния импорта

Возвращает текущее состояние импорта и возвращает количество успешных и неудачных записей.

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Идентификатор импорта
importId True string

Идентификатор импорта

Возвращаемое значение

Имя Путь Тип Описание
Id
Id string

Идентификатор импорта

Статус
Status string

Состояние импорта

Сообщение об ошибке
ErrorMessage string

Сообщение, описывающее, почему сбой импорта

Успешное выполнение
SuccessfulEntries integer

Количество записей, успешно импортированных

Неуспешные отступы
UnsuccessfulEntries integer

Количество записей, которые не удалось импортировать

TotalEntries
TotalEntries integer

Общее количество записей в импорте

ImportLink
ImportLink string

Ссылка на страницу записей для скачивания аннотированного файла

Получение файла

Возвращает файл по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор файла
id True string

Уникальный идентификатор файла

Возвращаемое значение

Ссылка на файл, содержащая данные и метаданные файлов

Тело
FileDataRef

Создание записи

Создает новую запись.

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Entry
entry True dynamic

Запись, созданная для формы

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Удаление записи

Удаление записи.

Параметры

Имя Ключ Обязательно Тип Описание
Form
form True string

Имя формы

Идентификатор записи
entryId True string

Идентификатор записи

Триггеры

При обновлении записи

Активирует, когда кто-то обновляет запись.

При создании новой записи

Активируется при создании новой записи.

При удалении записи

Активирует при удалении записи.

При обновлении записи

Активирует, когда кто-то обновляет запись.

Параметры

Имя Ключ Обязательно Тип Описание
Form
publisher True string

Имя формы

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При создании новой записи

Активируется при создании новой записи.

Параметры

Имя Ключ Обязательно Тип Описание
Form
publisher True string

Имя формы

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При удалении записи

Активирует при удалении записи.

Параметры

Имя Ключ Обязательно Тип Описание
Form
publisher True string

Имя формы

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Определения

FileDataRef

Ссылка на файл, содержащая данные и метаданные файлов

Имя Путь Тип Описание
Идентификатор файла
Id string

Уникальный идентификатор файла.

Имя файла
Name string

Имя файла

Тип контента файла
ContentType string

Тип контента файла.

Размер файла
Size integer

Размер файла.

URL-адрес файла
File string

URL-адрес файла.

Содержимое файла
Content byte

Содержимое файла

FormAvailability

Сведения о доступности форм, такие как начальная или конечная доступность и недоступное сообщение.

Имя Путь Тип Описание
Начало доступности форм
availabilityStart date-time

Начало доступности форм

Конец доступности форм
availabilityEnd date-time

Конец доступности форм

Недоступное сообщение
notAvailableMessage string

Недоступное сообщение

object

Это тип object.