Centrum pomocyIntegracje

Dla: Administratorzy

Wysyłaj formularze i czytaj odpowiedzi za pomocą klucza centralnego

Utwórz formularz dotyczący danej sprawy na podstawie szablonu, opublikuj go osobom, które powinny go wypełnić, i przeczytaj ich odpowiedzi.

W tym artykule7 sekcji

Zanim zaczniesz

Ta strona pokazuje, jak wysyłać formularze oraz jak odczytywać ich odpowiedzi za pomocą specjalnego klucza. Drogi do danych znajdują się pod https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Połączenia

DzwonićCo to robi
GET /forms/templatesLista twoich szablon formularowych
POST /formsStworzy formularz w tym przypadku, który nie został jeszcze opublikowany.
PUT /forms/<form_id>/publishPublikuje go, a następnie wysyła go do odbiorców.
GET /forms?filter=allWylicza formy sprawy
GET /forms/<form_id>Czytanie jednego formularza
PUT /forms/<form_id>Zmienia nazwę, datę terminu, informacje o terminie realizacji lub osoby, które otrzymają dane.
DELETE /forms/<form_id>Usuń to, wraz z odpowiedziami na te pytania.
GET /forms/<form_id>/responsesLista odpowiedzi
GET /forms/<form_id>/responses/<response_id>Czytam jedno odpowiedzi.
DELETE /forms/<form_id>/responses/<response_id>Usuwa odpowiedź jednej osoby, aby mogła ją ponownie wpisać.

Proces tworzenia formularza odbywa się w dwóch krokach: najpierw tworzy się go, a potem publikuje się. Dopóki formularz nie zostanie opublikowany, odbiorcy go nie widzą, a nikt o tym nie wie.

Tworzenie formularza

GET /forms/templates Lista twoich publikowanych danych szablonySzablon Wielokrotnego użytku wpis, formularz, podpis elektroniczny, notatka lub zadanie przechowywane w bibliotece i kopiowane do spraw., Najstarszy najpierw, z każdym z nich… asset_id, title, description, due_mins Ile minut minie od momentu wysłania danych? rrule (jego powtórzenie) notifications i instant_notify.

POST /forms przyjmuje:

PoleCo to robiWymaganyDomyślny
nameTytuł formularza. Litery, cyfry, spacje i & ' - _ ( ) . /; brak kółek ani przecinek.Tak.–
duration{"due_date": "2026-10-09T17:00:00-04:00", "rrule": "FREQ=MONTHLY"} Data terminu wymaga odstępu czasu geograficznego. rrule Reguła powtarzania jest opcjonalna. zoneinfo Czasowy okres, w którym reguła ta ma zastosowanie, np. America/New_York, również jest opcjonalny. Bez niego reguła ta będzie przyjmować czas geograficzny swojego „hubu”, w odpowiednim momencie i w dniu zmiany czasu.Tak.–
participants_idsLudzie, którzy je wypełniają: identyfikatory użytkowników osób związanych z tym przypadkiem, od GET /teamNie, ale konieczne było to opublikować.Nikt
template{"owner": "host", "template_id": "<asset_id>"} Aby użyć dokumentu danej szablonu.NieŻadnego.
descriptionNota podawana wraz z formularzemNieŠablona jest…
notificationsPamiątki: {"names": ["days", "hours"], "values": [-1440, -60]}, każda wartość w minutach przed terminem płatnościNieŠablona… lub nic.
instant_notifyfalse W czasie publikacji nie należy wysyłać żadnych żądań, tylko upomnienia.NieŠablona, czyli true

Šablona przenosi z sobą dokument, opis, ostrzeżenia itp. instant_notify, Ale nie w odpowiednim momencie, ani nie powtarzać tego procesu. Należy to wykonać równomiernie. due_date od due_mins, I wysłać je. rrule Jeśli tak jest.

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"}}'

Odpowiada na 201 za pomocą form_id. Dokument z tematu jest kopiowany w tle: należy przeczytać formularz aż do momentu, gdy nie będzie już żadnych copying. Następnie formularz można publikować.

Aby wysłać własny dokument, należy utworzyć formularz bez elementu template. Następnie należy załadować plik PDF jako dokument i czekać, aż będzie gotowy. Szczegóły znajdują się w opisie Wkładanie i przyłączanie plików za pomocą klucza hub.

Wydawniczy

PUT /forms/<form_id>/publish nie przyjmuje żadnego przedmiotu i odpowiada na 200.

  • Każdy odbiorca otrzymuje e-mail z prośbą o wypełnienie formularza. Jeśli nie ma aktywnego adresu e-mail, otrzymuje też wiadomość tekstowa. To odbywa się natychmiast, chyba że… instant_notify to false. Wygląda na to, że znajduje się na nich. ZrobićDo zrobienia Lista rzeczy czekających na Ciebie, np. formularzy do wypełnienia, dokumentów do podpisania lub zdarzeń do potwierdzenia. A także w powiadomieniach przesyłanych na ich portalu.
  • Pamiątki są wysyłane za każdym razem w okresie notifications. Nic nie jest wysyłane w odpowiednim czasie, a odpowiedzi przyjmuje się dopiero po tym okresie.
  • Formularz powtarzający przechodzi do następnego terminu wypełnienia. Jego odpowiedzi są jasne, a wszyscy uczestnicy ponownie zostają zapytani o swoje odpowiedzi, chyba że instant_notify jest równy false.
  • Ktoś, kto nie ma żadnego związku z tą sprawą, zostaje usunięty z listy osób zainteresowanych.

Dokument nie może zostać zmieniony po publikacji formularza. Jego nazwa, data terminu, powiadomienia, odbiorcy oraz opis mogą być zmienione po publikacji formularza. PUT /forms/<form_id>; Przesłane z powrotem bez żadnych zmian. zoneinfo Zachowuje tę część czasu, którą już ma. Jeśli zmienimy datę terminu, żądanie zostanie wysłane ponownie do wszystkich, którzy jeszcze nie odpowiedzieli. Ludzie, których dodajemy do listy odbiorców, również otrzymają tę wiadomość natychmiast. instant_notify false, Nie idzie nawet wtedy, gdy nadchodzą upomnienia.

Czytanie odpowiedzi

GET /forms/<form_id>/responses przedstawia odpowiedzi każdej osoby, w kolejności według wieku, na jednej stronie. Formularz powtarzający wyświetla tylko odpowiedzi z bieżącego dnia; odpowiedzi z wcześniejszych dni nadal są widoczne w formularzu 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 Każdy pol jest obsadzany przez osobę, która go wypełniła. name. Podpis lub rysunek należy do… annotations i attachments.
  • Wynik pobrania danych pokazuje, kto złożył odpowiedź: responses przekazuje identyfikator użytkownika każdej osoby do jej response_id.
  • Gdy ktoś składa wniosek, pracownicy zajmujący się tą sprawą otrzymują informacje w taki sam sposób, jak gdyby sami przesłali ten wniosek.

Usunięcie odpowiedzi danej osoby, przy użyciu {"user_id": "<their ID>"} jako elementu zawierającego informacje o odpowiedzi, sprawia, że formularz znajduje się ponownie na liście zadań do wykonania tej osoby. Nikt nie jest poinformowany o tym. Klucz sam nie może wypełnić formularza.

Formularze ofertowe

GET /forms wymaga filter.

filterCo wymienia
allKażda forma tego projektu, w tym te nieopublikowane, należy przede wszystkim sortować według kolejności publikacji.
selfWirtualny asystent może zostać wysłany za pomocą dowolnego z twoich kluczy, lub poprzez automatyzację.
completed, uncompletedFormularze, które należy wypełnić przez osobę telefonującą. Zawsze są puste w przypadku klucza.

Każda forma zawiera swoje wartości: form_id, name, participants_ids, due_date, published (po jednym publikowaniu 1), responses, responses_ct oraz dokument pod numerem media.

DELETE /forms/<form_id> może kiedykolwiek usunąć formularz wraz z odpowiedziami na niego, i wtedy ten formularz znika z listy zadań do wykonania przez wszystkich. Nikt o tym nie wie.

Jeśli połączenie zostanie odrzucone

StatusmessageDlaczego
400SchemaFieldsExceptionBrakuje lub nieprawidłowo wygenerowanego pola. Na przykład brakuje kropki w name, termin płatności nie ma odpowiedniego offsetu, albo osoba ta nie znajduje się w bazie danych. errors określa nazwę tego pola.
400SchemaFieldsException, przy czym ItemCopyNotAllowedException znajduje się w obrębie templateŠablona nie została opublikowana, nie jest dostępna dla botów, lub jej pliki nadal są przetwarzane.
403PublishAlreadyPublishedExceptionJuż zostało to opublikowane.
403PublishAlreadyAnsweredExceptionKtoś już odpowiedział na to pytanie.
403PublishMediaMissingExceptionJeszcze nie ma żadnych dokumentów związanych z tym tematem.
403PublishMediaNotReadyExceptionJego dokument jest nadal kopiowany lub konwertowany na inny format.
403PublishMediaFailedExceptionJego dokument nie zdołał zostać przetworzony.
403PublishDueTimePassedExceptionData wydania minęła
403PublishRecipientsMissingExceptionNie ma nikogo, do kogo można je wysłać.
403BotNotAllowedExceptionKlucz próbował go wypełnić.
403CaseClosedExceptionSprawa została zamknięta.
404ItemNotFoundExceptionForma lub odpowiedź w ogóle nie istnieją.

Informacje dotyczące kodu błędów oraz pozostałych kodów znajdują się w sekcji Obsługa błędów API i kodów statusowych.

Powiązane artykuły

Zrozum, co może zrobić APIDowiedz się, do czego służy klucz zarządzający i klucz centralny, dlaczego każdy klucz pełni funkcję wirtualnego asystenta i gdzie znajduje się pełna lista danych technicznych.IntegracjeWysyłaj podpisy elektroniczne i czytaj podpisy za pomocą klucza centralnegoUtwórz podpis elektroniczny w sprawie z szablonu, wybierz, kto podpisze każde pole, opublikuj sprawę do podpisu i pobierz zablokowaną kopię, gdy wszyscy podpiszą.IntegracjePrzesyłaj i dołączaj pliki za pomocą klucza HubUzyskaj adres do przesyłania, prześlij plik, załącz go do wpisu, notatki, zadania, formularza lub podpisu elektronicznego i pobierz pliki sprawy.IntegracjeObsługa błędów API i kodów statusuPrzeczytaj treść błędu, co oznaczają kody 400, 401, 403, 404, 500 i 503 i dlaczego element, którego klucz dotyczy, nie widzi odpowiedzi 404.Integracje