Utilisez le type de demande de données de formulaire pour ajouter divers paramètres au corps de votre demande.

Actions

Les actions de paramètre suivantes sont activées :

Ajouter
Pour ajouter des paramètres au corps de la requête.
Cliquez sur l\'icône Ajouter pour ajouter un paramètre. Le nombre de paramètres affiché dans le titre du tableau Paramètres est mis à jour automatiquement.
Modifier
Pour modifier les paramètres existants disponibles dans le corps de la requête.
Dans le tableau des Paramètres, survolez l\'icône de l\'ellipse verticale du paramètre que vous souhaitez modifier, puis cliquez sur l\'icône Modifier. Vous pouvez modifier la clé, le type de clé et les valeurs des paramètres dans la fenêtre modale Modifier le paramètre.
Activer/Désactiver
Pour activer ou désactiver les paramètres disponibles dans le corps de la requête. Vous pouvez désactiver un paramètre pour les scénarios suivants :
  • Lorsque la requête API utilise des valeurs par défaut.
  • Lors de l\'introduction d\'une nouvelle fonctionnalité dans le déploiement contrôlé d\'un ensemble de connecteurs.
  • Lors des tests et de l\'itération de nouvelles fonctionnalités dans un package de connecteur.
  • Lors du dépannage d\'un package de connecteur contenant des paramètres avec des erreurs.
Dans le tableau Paramètres, survolez l\'icône de l\'ellipse verticale du paramètre que vous souhaitez activer ou désactiver, puis cliquez sur le bouton Activer/Désactiver. Le statut du paramètre est mis à jour en conséquence dans le tableau Parameters. Les paramètres désactivés ne sont pas inclus dans le package de connecteur publié.
Copier
Pour reproduire les paramètres existants disponibles dans le corps de la requête.
Dans le tableau des Paramètres, survolez l\'icône de l\'ellipse verticale du paramètre approprié, puis cliquez sur l\'icône Copier pour dupliquer le paramètre sélectionné. Assurez-vous de saisir une nouvelle clé dans la fenêtre modale Copier. Tous les autres attributs du paramètre original sont copiés dans le nouveau paramètre. Une fois copié, le nouveau paramètre est activé par défaut. Utilisez le bouton Activer/Désactiver pour désactiver le paramètre manuellement. Le nombre de paramètres dans le titre du tableau Paramètres est mis à jour automatiquement lorsqu\'un nouveau paramètre est créé en utilisant l\'option Copier.
Vous pouvez modifier le type de clé et le type de valeur du paramètre dupliqué dans la fenêtre modale de copie.
Supprimer
Pour supprimer les paramètres disponibles dans le corps de la requête.
Pour supprimer des paramètres, effectuez l\'une des actions suivantes :
  • Cliquez sur la case à cocher Sélectionner tout dans l\'en-tête du tableau, puis cliquez sur l\'icône Supprimer disponible au-dessus du tableau pour supprimer plusieurs paramètres.
  • Survolez le menu à points de suspension vertical de chaque paramètre, puis cliquez sur l\'icône Supprimer pour supprimer le paramètre individuellement.

Tableau de paramètres

Le titre du tableau des paramètres affiche le nombre total de paramètres de requête dans une action. Ce nombre inclut à la fois les paramètres activés et désactivés.

Affichez les détails des paramètres suivants dans le tableau.

Colonne Description
Clé Affiche la clé du paramètre. L\'utilisateur du package ne peut pas afficher la clé dans Éditeur de Bot ou dans l\'éditeur de Tâche API. La clé est envoyée en tant que partie de l\'en-tête.
Type de clé affiche le type de données de formulaire. Il détermine la manière dont les données sont interprétées et gérées.
  • Texte : Si le type de clé est une simple entrée de texte. Le contenu est traité comme du texte brut (texte/texte brut). Ce type de clé convient aux données telles que les noms, les adresses ou les descriptions.
  • Fichier : Si le type de clé est un chargement de fichier binaire. Le contenu est constitué des données brutes du fichier chargé. Ce type de clé est utilisé pour charger des documents, des images ou d\'autres données binaires.
    Remarque : Le champ Type de fichier est toujours défini par l\'utilisateur, et les utilisateurs peuvent charger des fichiers par l\'intermédiaire de l\'Éditeur de Bot.
Valeur Affiche la valeur du paramètre. L\'utilisateur du package peut afficher cette valeur dans Éditeur de Bot ou Tâche API l\'éditeur et peut la mettre à jour.
La valeur est fournie par l\'utilisateur affiche le statut de la valeur.
  • Oui : Si la valeur est fournie par l\'utilisateur. L\'utilisateur du package doit fournir une valeur appropriée lors de la configuration de ce paramètre dans Éditeur de Bot ouTâche API éditeur.
  • Non : Si la valeur est codée en dur. L\'utilisateur du package ne peut pas afficher cette valeur dans Éditeur de Bot ou Tâche APIéditeur. Cette valeur est envoyée en tant que partie de l\'en-tête.
Statut Affiche le statut du paramètre.
  • Activé: Si le paramètre est activé.
  • Désactivé: Si le paramètre est désactivé.
Étiquette Affiche l\'étiquette pour les valeurs fournies par l\'utilisateur. L\'utilisateur du package peut afficher l\'étiquette du paramètre dans Éditeur de Bot ou Tâche APIéditeur.
Description Affiche la description du paramètre. L\'utilisateur du package peut afficher la description du paramètre dans Éditeur de Bot ou Tâche APIéditeur.

Ajouter des paramètres au corps de la demande

Pour ajouter un paramètre au corps de la requête de données du formulaire, suivez ces étapes :

  1. Cliquez sur l\'onglet Corps de la requête dans le volet Configuration.
  2. Sélectionnez Données du formulaire dans la liste déroulante Type.
  3. Cliquez sur Ajouter un paramètre ou sur l\'icône plus (+) en haut du tableau pour ajouter un paramètre.
  4. Effectuez les actions suivantes dans la fenêtre modale Ajouter un paramètre.
    1. Clé : Entrez un nom de clé approprié. Le nom de clé n\'est pas affiché pour l\'utilisateur du package dans Éditeur de Bot ou dans l\'éditeur de Tâche API. Ce nom est envoyé en tant que partie de l\'en-tête.
    2. Type de clé: Sélectionnez le type de clé approprié dans la liste déroulante.
    3. Sélectionnez l\'une des options suivantes dans la section La valeur sera :
      Type Description
      Codé en dur Entrez une valeur codée en dur pour le paramètre. L\'utilisateur du package ne peut pas afficher cette valeur dans Éditeur de Bot ou Tâche APIéditeur. Cette valeur est envoyée en tant que partie de l\'en-tête.
      Fourni par l\'utilisateur
      1. Type de saisie de valeur : Activez cette case à cocher si vous souhaitez sécuriser le type de valeur d\'entrée. Lorsque vous sélectionnez Sécurisé, vous pouvez entrer le paramètre via une information d\'identification, une variable ou une chaîne non sécurisée.
      2. Ce champ est-il obligatoire ?: Sélectionnez Non ou Oui en fonction des exigences du paramètre.
      3. Valeur (facultatif) : Saisissez une valeur. L\'utilisateur du package peut afficher cette valeur dans Éditeur de Bot ou Tâche APIéditeur et peut la mettre à jour.
      4. Étiquette : Entrez une étiquette pour le paramètre. L\'utilisateur du package peut afficher l\'étiquette du paramètre dans Éditeur de Bot ou Tâche APIéditeur.
      5. Description (facultatif) : Saisissez une description pour le paramètre. L\'utilisateur du package peut afficher la description du paramètre dans Éditeur de Bot ou Tâche APIéditeur. La description apparaît comme texte d\'aide dans l\'éditeur.
  5. Cliquez sur Ajouter pour ajouter le paramètre au corps de la requête.

    Le nouveau paramètre s\'affiche dans le tableau Parameters.

Répétez les étapes pour ajouter d\'autres paramètres au corps de la requête.