Центр поддержкиИнтеграции

Для: Администраторы

Отправляйте формы и читайте ответы с помощью центрального ключа.

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

В этой статье7 разделов

Прежде чем начать

На этой странице рассказывается о том, как отправлять формы и читать их ответы с использованием специального ключа. Пути для этого находятся под https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Звонки

ВызовЧто это делает
GET /forms/templatesСписок шаблонов форм вашего проекта
POST /formsСоздается форма для обработки данных; эта форма пока не опубликована.
PUT /forms/<form_id>/publishОпубликувается это сообщение; затем оно доставляется получателям.
GET /forms?filter=allПеречень форм данного случая
GET /forms/<form_id>Читает один формат данных.
PUT /forms/<form_id>Изменяется название, дата отправки, уведомления или получатели сообщений.
DELETE /forms/<form_id>Удалите его вместе с ответами на вопросы.
GET /forms/<form_id>/responsesСписок ответов на вопросы
GET /forms/<form_id>/responses/<response_id>Читает одну из ответов.
DELETE /forms/<form_id>/responses/<response_id>Удаляется ответ одного человека, чтобы он мог снова заполнить этот ответ.

Процесс создания формы происходит в два этапа: сначала форма создается, а затем опубликовывается. До момента публикации форма не видна для получателей сообщений, и никто об этом не знает.

Создание формы

GET /forms/templates Перечисление ваших опубликованных работ/материалов ШаблоныШаблон Многоразовая запись в ленте новостей, форма, электронная подпись, заметка или задание, хранящиеся в библиотеке и копируемые на витрины., Старшие по возрасту первыми, каждый из них… asset_id, title, description, due_mins Сколько минут прошло с момента отправки сообщения? rrule (Его повторение) notifications и instant_notify.

POST /forms принимает следующие значения:

ПолеЧто это делаетНеобходимыйПо умолчанию
nameНазвание формы. Символы: буквы, цифры, пробелы, а также символ & ' - _ ( ) . /. Нет запятых или точек.Да.—
duration{"due_date": "2026-10-09T17:00:00-04:00", "rrule": "FREQ=MONTHLY"}. У даты выпуска необходимо указать часовой пояс. rrule, Правило повторения является факультативным. zoneinfo, Часовая зона, в которой происходит повторение событий, например: America/New_York, Это опционально: без этого повторение действий сохраняет часовой пояс вашего хаба в тот же самый день и в то же время, когда происходит изменение часовых поясов.Да.—
participants_idsЛюди, которые вносят информацию в этот раздел: идентификационные номера пользователей, связанных с данным случаем, от GET /teamНет, но необходимо опубликовать этот текст.Никто
template{"owner": "host", "template_id": "<asset_id>"} Использовать документ, созданный с помощью шаблона.Нет.Ничего.
descriptionПримечание, прилагаемое к формеНет.Шаблоны
notificationsНапоминания: {"names": ["days", "hours"], "values": [-1440, -60]}. Каждое значение указывает количество минут до наступления срока выполнения задачи.Нет.Шаблон… или ничего.
instant_notifyfalse Не отправлять никаких запросов во время публикации; достаточно использовать только напоминания.Нет.Шаблоны, или true

Шаблон передает документ, его описание, напоминания, а также значение instant_notify. Однако он не передает информацию о сроках выполнения задач и о возможности повторного выполнения действий. Необходимо вычислить значение due_date из значения due_mins. Если таковое имеется, то необходимо отправить соответствующее значение rrule.

curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/forms \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Case intake form", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "participants_ids": ["cu-4f1c2a9e8b7d60"], "template": {"owner": "host", "template_id": "form::20260915101500_3c2b1a0f9e8d70"}}'

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

Если вы хотите отправить свою собственную документацию, создайте форму без элемента template. Затем загрузите PDF-файл в качестве документа. Подождите, пока все будет готово. См. раздел Загрузка и приложение файлов с использованием ключа хаба.

Издательский

PUT /forms/<form_id>/publish не принимает никакого значения и возвращает значение 200.

  • Каждому получателю отправляется письмо с просьбой заполнить его. Если у получателя нет подтвержденной электронной почты, ему также отправляется сообщение по текстовой связи. Это происходит немедленно, если только… instant_notify есть false. Это видно на их… Что нужно сделатьДелать Список дел, ожидающих вас, таких как заполнение форм, подписание документов или подтверждение событий. И также в уведомлениях на их портале.
  • Повторные уведомления отправляются каждый раз в период notifications. Ничего не отправляется в установленное время, а ответы принимаются после этого времени.
  • Повторяющаяся форма переходит к следующей дате выполнения задания. Ответы на вопросы очевидны, и все участники снова получают возможность ответить на вопросы, если только instant_notify не равно false.
  • Те люди, которые не имеют отношения к данному делу, исключаются из списка участников процесса.

Документ не может быть изменен после того, как он опубликован. Название документа, дата окончания срока, список получателей и описание документа могут быть изменены после публикации. PUT /forms/<form_id>; Опять отправлено без необходимых изменений. zoneinfo Это сохраняет тот часовой пояс, который уже имеется. При изменении даты окончания срока, запросы будут отправлены снова, но уже немедленно всем тем, кто еще не ответил. Люди, которых вы добавляете в список, также получат этот запрос сразу же. instant_notify false, Ничего не происходит до тех пор, пока не придут напоминания.

Чтение ответов

В таблице GET /forms/<form_id>/responses перечислены ответы каждого человека; даты ответов указаны в порядке возрастания. Таблица с повторяющимися данными содержит информацию только о текущей дате; ответы за более ранние даты все равно отображаются по их response_id-им значениям.

{
  "data": {
    "items": [
      {
        "response_id": "response::20261003153012_9f8e7d6c5b4a30",
        "parent_id": "form::20261002150000_1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "created_on": "2026-10-03T15:30:12+00:00",
        "response": {
          "format": "https://pspdfkit.com/instant-json/v1",
          "formFieldValues": [
            {"v": 1, "type": "pspdfkit/form-field-value", "name": "client_name", "value": "Jane Sample"},
            {"v": 1, "type": "pspdfkit/form-field-value", "name": "accident_date", "value": "2026-09-14"}
          ]
        }
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/forms/form::20261002150000_1a2b3c4d5e6f70/responses"
  }
}
  • formFieldValues соответствует каждой информации, заполненной человеком; эта информация хранится в поле с идентификатором name. Подкатегории для подписи или рисунка выделены с помощью полей annotations и attachments.
  • Форма сама по себе показывает, кто ответил на запрос: responses соответствует идентификатору пользователя, а response_id — его имени.
  • Когда кто-то представляет документы, сотрудники, занимающиеся этим делом, получают информацию о том, что они должны были сделать самостоятельно при отправке документов.

Удаление ответа одного человека, используя форму {"user_id": "<their ID>"}, возвращает эту форму обратно в список задач этого человека. Никому не сообщается о произошедшем. Ключ не может самостоятельно заполнить форму.

Формы для размещения объявлений

GET /forms требует использования filter.

filterЧто в нём перечислено
allВсе формы, включая неопубликованные, рассматриваются в порядке их последовательности. Самые новые формы располагаются в начале списка.
selfВиртуальный помощник отправляется по любому из ваших ключей или с помощью автоматизации.
completed, uncompletedЭти формы предназначены для заполнения человеком, который звонит. Они всегда остаются пустыми в случае отсутствия ключа.

Каждый формат содержит свои значения form_id, name, participants_ids, due_date, published (а также 1 после его публикации), responses, responses_ct, а также документ, находящийся под элементом media.

DELETE /forms/<form_id> может удалить любой формуляр в любое время, включая все его ответы. Таким образом, этот формуляр исчезает из списка задач для всех участников. Никому не сообщается об этом.

Если звонок отклонен

СтатусmessageПочему
400SchemaFieldsExceptionВ данном поле отсутствуют или имеются некорректные значения. Например, в строке name может быть неправильное расположение точек между элементами; также может быть не указан срок окончания выполнения задачи. Кроме того, может быть такой случай, когда человек, который должен выполнить определенную задачу, на самом деле не находится в списке участников этой задачи. errors указывает имя этого человека.
400SchemaFieldsException, при условии, что ItemCopyNotAllowedException находится в пределах templateШаблон еще не опубликован, он не доступен для использования роботами, или его файлы все еще обрабатываются.
403PublishAlreadyPublishedExceptionЭто уже опубликовано.
403PublishAlreadyAnsweredExceptionКто-то уже ответил на этот вопрос.
403PublishMediaMissingExceptionПока у него нет никаких документов.
403PublishMediaNotReadyExceptionЕго документ все еще находится в процессе копирования или преобразования.
403PublishMediaFailedExceptionЕго документ не смог быть преобразован в нужном формате.
403PublishDueTimePassedExceptionСрок его использования уже истек.
403PublishRecipientsMissingExceptionУ него нет никого, кому можно отправить это.
403BotNotAllowedExceptionКлюч пытался заполнить это пробел.
403CaseClosedExceptionДело закрыто.
404ItemNotFoundExceptionЭтой формы или ответа не существует.

Что касается текста ошибок и остальных кодов, см. раздел Управление ошибками API и статусными кодами.

Статьи по теме

Разберитесь, что может делать API.Узнайте, к чему могут иметь доступ ключ управления и ключ концентратора, почему каждый ключ действует как виртуальный помощник и где находится полный технический паспорт.ИнтеграцииОтправляйте электронные подписи и считывайте подписи с помощью центрального ключа.Создайте электронную подпись для дела на основе шаблона, выберите, кто подпишет каждое поле, опубликуйте документ для подписания и загрузите заблокированную копию после того, как все подпишут.ИнтеграцииЗагружайте и прикрепляйте файлы с помощью ключа хаба.Получите адрес для загрузки, загрузите файл, прикрепите его к сообщению, заметке, заданию, форме или электронной подписи, а также скачайте файлы дела.ИнтеграцииОбработка ошибок и кодов состояния API.Прочитайте текст ошибки, что означают коды 400, 401, 403, 404, 500 и 503, и почему элемент, который ваш ключ не видит, выдает ошибку 404.Интеграции