Centre d'aideIntégrations

Pour: Administrateurs

Envoyez des formulaires et consultez les réponses grâce à une clé de hub.

Créez un formulaire à partir d'un modèle, publiez-le à l'intention des personnes concernées et lisez leurs réponses.

Dans cet article7 sections

Avant de commencer

Cette page traite de la envoi de formulaires et de l’analyse des réponses qu’ils contiennent, en utilisant une clé de hub. Les chemins de navigation se trouvent sous https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Appels

AppelCe que cela fait
GET /forms/templatesListe des modèles de formulaire de votre application.
POST /formsCrée un formulaire sur le cas en question, mais ce formulaire n’est pas publié.
PUT /forms/<form_id>/publishIl le publie, ce qui permet de l’envoyer aux destinataires.
GET /forms?filter=allListe des formes de l’affaire
GET /forms/<form_id>Lise une forme.
PUT /forms/<form_id>Il change son nom, la date d’expiration, les rappels ou les destinataires des messages.
DELETE /forms/<form_id>Supprime-le, ainsi que ses réponses.
GET /forms/<form_id>/responsesListe de ses réponses
GET /forms/<form_id>/responses/<response_id>Lise une réponse.
DELETE /forms/<form_id>/responses/<response_id>Cela supprime la réponse d’une personne, afin qu’elle puisse la remplir à nouveau.

Une forme se crée en deux étapes : d’abord, on la crée, puis on la publie. Jusqu’à ce qu’elle soit publiée, ses destinataires ne la voient pas, et personne n’est informé de son existence.

Création d'un formulaire

GET /forms/templates liste les modèles publiésModèle Un flux RSS, un formulaire, une signature électronique, une note ou une tâche réutilisable, conservé dans la bibliothèque et copié dans les dossiers.. Ces modèles sont classés par ordre de date d’envoi, avec pour chaque modèle des informations telles que asset_id, title, description, due_mins (le nombre de minutes écoulées depuis l’envoi du modèle), rrule (la fréquence d’envoi du modèle), notifications et instant_notify.

POST /forms accepte les valeurs suivantes :

ChampCe que cela faitRequisDéfaut
nameLe titre du formulaire. Des lettres, des chiffres, des espaces, et & ' - _ ( ) . / ; pas de virgules ni de points-virgues.Oui.—
duration{"due_date": "2026-10-09T17:00:00-04:00", "rrule": "FREQ=MONTHLY"}. La date d’échéance doit être corrigée en tenant compte de l’heure locale. rrule, Une règle de répétition est facultative. zoneinfo, L’heure de la zone horaire où cette répétition se produit, par exemple… America/New_York, C’est optionnel : sans cette option, le répéteur conserve l’heure de la zone horaire de votre hub, à l’heure et le jour où les heures changent.Oui.—
participants_idsLes personnes qui le remplissent : les identifiants des utilisateurs concernés, provenant de GET /teamNon, mais il était nécessaire de le publier.Personne
template{"owner": "host", "template_id": "<asset_id>"} Pour utiliser le document d’un modèle.Non.Aucun.
descriptionUne note accompagnant le formulaireNon.Le modèle est…
notificationsRemarques : {"names": ["days", "hours"], "values": [-1440, -60]}. Chaque valeur représente le nombre de minutes restantes avant la date de fin.Non.Le modèle… ou rien du tout.
instant_notifyfalse Ne pas envoyer de demandes lors de la publication ; seules les notifications seront envoyées.Non.Le modèle, ou true

Un modèle contient le document lui-même, sa description, les rappels, ainsi que l’élément instant_notify. Mais il ne contient pas la date de remise ou les informations relatives aux répétitions. Il suffit de déterminer la valeur de due_date à partir de due_mins. Ensuite, on envoie le rrule s’il existe.

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

Cela répond à 201 avec form_id. Le document du modèle est copié en arrière-plan : lisez le formulaire jusqu’à ce qu’il ne contienne plus de copying. Ensuite, publiez-le.

Pour envoyer votre propre document, créez le formulaire sans l’élément template. Ensuite, téléchargez un fichier PDF en tant que document, et attendez que tout soit prêt. Pour plus d’informations, consultez la section Enregistrer et joindre des fichiers avec une clé hub.

Édition

PUT /forms/<form_id>/publish ne prend aucun corps et renvoie 200.

  • Chaque destinataire reçoit par e-mail une demande à remplir. Si son adresse e-mail n’est pas confirmée, il reçoit également un message texte, immédiatement. instant_notify C’est. false. Il apparaît sur leurs… À faireFaire La liste des choses qui vous attendent, comme des formulaires à remplir, des documents à signer ou des événements à confirmer. Et également dans les notifications affichées sur leur portail.
  • Les rappels sont envoyés à chaque fois. notifications Il reste encore beaucoup de travail à faire. Rien n’est envoyé à temps, et les réponses ne sont acceptées qu’après le délai imparti.
  • Une forme de répétition se déplace vers sa prochaine date d’expiration à chaque fois. Les réponses sont claires, et tous les participants sont interrogés à nouveau immédiatement, à moins que instant_notify ne soit égal à false.
  • Toute personne qui n’a rien à voir avec l’affaire est supprimée de la liste des participants.

Le document ne peut pas être modifié une fois qu’il est publié. Son nom, la date d’expiration, les rappels, les destinataires et la description peuvent être modifiés. PUT /forms/<form_id>; Un message reçu à nouveau, sans aucun élément supplémentaire. zoneinfo Il conserve le fuseau horaire qu’il possède déjà. En changeant la date limite, les demandes de rappel ou d’information sont envoyées à nouveau à tous ceux qui n’ont pas répondu. Les personnes que vous ajoutez à la liste de destinataires reçoivent également cette information immédiatement. instant_notify false, Rien ne se passe avant que les rappels ne soient envoyés.

Réponses de lecture

GET /forms/<form_id>/responses liste les réponses de chaque personne, en ordre décroissant de l’âge, toutes sur une seule page. Un formulaire répétitif ne montre que les réponses pour la date actuelle ; les réponses pour des dates antérieures sont toujours affichées grâce à leur 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 contient les informations que la personne a saisies pour chaque champ, selon les valeurs indiquées dans les champs correspondants name. Une signature ou un dessin est classé sous les catégories annotations et attachments.
  • La fonction de lecture de la forme indique qui a répondu : responses associe l’identifiant utilisateur de chaque personne à son response_id correspondant.
  • Lorsqu’une personne soumet le dossier, le personnel chargé de l’affaire est informé, de la même manière que s’il avait été lui-même celui qui avait envoyé le dossier.

Supprimer la réponse d’une personne, en utilisant {"user_id": "<their ID>"} comme corps de la formule, place cette réponse à nouveau dans la liste des tâches à accomplir. Personne n’est informé de cela. Une clé ne peut pas remplir elle-même une formule.

Formulaires d'inscription

GET /forms nécessite filter.

filterCe qu'il liste
allToutes les formes de ce cas, y compris celles qui ne sont pas encore publiées, en ordre de précision croissante.
selfLe assistant virtuel est envoyé par l’une de vos clés, ou via des automatisations.
completed, uncompletedLes formulaires que le personne qui appelle doit remplir sont toujours vides pour une clé.

Chaque forme contient ses valeurs form_id, name, participants_ids, due_date, published (et 1 une fois publiées), responses, responses_ct, ainsi que son document sous media.

DELETE /forms/<form_id> peut supprimer un formulaire à tout moment, ainsi que ses réponses associées. Ce formulaire est alors retiré de la liste des tâches à accomplir pour tout le monde. Personne n’est informé de cette suppression.

Si un appel est refusé

StatutmessagePourquoi
400SchemaFieldsExceptionUn champ est manquant ou n’est pas valide. Par exemple, une virgule dans name, une date de fin sans décalage, ou une personne qui n’est pas inscrite dans le cas en question. errors indique son nom.
400SchemaFieldsException, avec ItemCopyNotAllowedException à templateLe modèle n’est pas publié, il n’est pas accessible aux bots, ou ses fichiers sont encore en cours de traitement.
403PublishAlreadyPublishedExceptionIl est déjà publié.
403PublishAlreadyAnsweredExceptionQuelqu’un l’a déjà répondu.
403PublishMediaMissingExceptionIl n’y a encore aucun document correspondant.
403PublishMediaNotReadyExceptionSon document est toujours en cours de copie ou de conversion.
403PublishMediaFailedExceptionSon document n’a pas pu être converti.
403PublishDueTimePassedExceptionLa date de réception de ce document est déjà passée.
403PublishRecipientsMissingExceptionIl n’a personne à qui il puisse l’envoyer.
403BotNotAllowedExceptionUne clé a essayé de le remplir.
403CaseClosedExceptionL’affaire est close.
404ItemNotFoundExceptionLa forme ou la réponse en question n’existe pas.

Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.

Articles connexes

Comprendre les possibilités de l'APIDécouvrez ce que permettent chacune une clé de gestion et une clé de hub, pourquoi chaque clé agit comme un assistant virtuel et où trouver la liste technique complète.IntégrationsEnvoyez des signatures électroniques et lisez les signatures avec une clé de hubCréez un formulaire de signature électronique pour un dossier à partir d'un modèle, choisissez qui signe chaque champ, publiez-le pour signature et téléchargez la copie verrouillée une fois que tout le monde a signé.IntégrationsTéléversez et joignez des fichiers à l'aide d'une clé de hub.Obtenez une adresse de téléchargement, téléchargez un fichier, joignez-le à une publication, une note, une tâche, un formulaire ou une signature électronique, et téléchargez les fichiers d'un dossier.IntégrationsGérer les erreurs et les codes d'état de l'APILisez le corps de l'erreur, ce que signifient les codes 400, 401, 403, 404, 500 et 503, et pourquoi un élément que votre clé ne peut pas voir renvoie la réponse 404.Intégrations