Aller au contenu
Documentation

Définition de l'objet

Formulaire

Form

Les propriétés d'une fiche « Formulaire », ses énumérations et ses liaisons avec les autres fiches.

28 propriétés 2 énumérations 39 liaisons
4 min de lecture Mise à jour le 11 novembre 2026

Une fiche « Formulaire », telle que l'API la lit et l'écrit (Form dans la référence). Sa liste et sa création : https://staging-api.docage.com/Forms ; une fiche : https://staging-api.docage.com/Forms/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.

38 fiches liées · survolez une fiche pour lire son nom et son rôle

Ses propriétés

  • BoxFormsliste de BoxForm

    Formulaires dans classeurs

  • CustomFieldsliste de Field

    CustomFields augmented with FieldsWithUserData for columns in formInstances

  • DefaultFormTypeDefaultFormTypeLecture seule

    Le type d'écran système que ce formulaire incarne — formulaire de parcours, de réservation, de vérification des coordonnées, d'accès par code, de téléchargement d'un transfert, ou sous-formulaire —, None pour un formulaire ordinaire. Posé sur les modèles système, recopié par la duplication sur la copie qu'une organisation en tire : c'est ce qui fait apparaître cette copie dans le sélecteur du bon type. Accepté à la création, figé ensuite : un formulaire ne change pas d'écran. Un formulaire typé dont un champ verrouillé manque est refusé, à la création comme à la modification.

  • DesktopStyleFormStyle

    Style pour affichage sur bureau

  • DocageUserIdidentifiant

    Identifiant de l'utilisateur

  • Fieldsliste de Field

    Champs

  • FieldsWithUserDataliste de Field

    Tous les champs personnalisés de l'organisation et du modèle

  • FormValidationProtectedBySecurityCodeoui ou non

    Validation du formulaire protégée par code de sécurité

  • FormValidationSecurityCodeIdidentifiantÉcrite par le serveur

    Identifiant du code de sécurité de validation du formulaire

  • GateFormIdidentifiant

    Identifiant du formulaire d'accès par code

  • IntegrationLinktexte

    Lien d'intégration

  • MailSettingsFormMailSettings

    Paramètres des emails du formulaire

  • MobileStyleFormStyle

    Style pour affichage sur mobile

  • Nametexte

    Nom

  • OpenRedirectionInNewTaboui ou non

    Ouvrir la redirection dans un nouvel onglet

  • OpenRedirectionInParentPageoui ou non

    Ouvrir la redirection dans la page parente

  • PreFillFormoui ou non

    Pré-remplir le formulaire

  • RedirectionTargetRedirectionTarget

    Cible de redirection

  • RedirectionUrltexte

    URL de redirection

  • ResultWebPageIdidentifiant

    Identifiant de la page de remerciement

  • SourceWebPageIdidentifiantÉcrite par le serveur

    Identifiant de la page web d'origine

  • SubFormDefinitionIdidentifiant

    Identifiant du type de carte ou d'objet lié au sous-formulaire

  • SubFormEntityTypetexte

    Type de fiche lié au sous-formulaire

  • SubFormTemplateIdidentifiant

    Identifiant du modèle de fiche lié au sous-formulaire

  • SubmitCountentierLecture seule

    Nombre de soumissions

  • TransactionTemplateIdidentifiant

    Le modèle de parcours pour lequel le formulaire est écrit (facultatif) : un participant renommé dans ce modèle l'est aussi dans le formulaire. Un modèle de parcours actif que vous voyez, de l'organisation du formulaire ou de la plateforme ; sinon l'écriture est refusée (422).

  • UseDesktopStyleForMobileoui ou non

    Utiliser le style bureau pour mobile

  • ViewCountentierLecture seule

    Nombre de vues

Ses énumérations

DefaultFormType

  • 0Aucun
  • 5Formulaire de réservation
  • 8Formulaire de parcours
  • 12Formulaire de vérification des coordonnées
  • 13Formulaire d'accès par code de sécurité
  • 14Sous-formulaire
  • 15Formulaire de téléchargement des transferts

RedirectionTarget

  • 0Même page
  • 1Page parente
  • 2Page principale
  • 3Nouvel onglet

Ses liaisons

Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans une liste (voir Lire des listes).