Accéder au contenu principal Passer au contenu complémentaire

Créer un type de données

Un type de données est une description des données échangées sur le réseau. Il peut être réutilisé dans toute la version de l'API.

Procédure

  1. Cliquez sur le bouton + dans le coin supérieur droit du panneau de gauche.
    Note InformationsConseil : Si vous souhaitez créer un type de données directement à partir d'une section créée antérieurement, il vous suffit de cliquer sur le bouton + à droite du nom de la section.
  2. Cliquez sur Data type.
  3. Saisissez un nom pour votre type de données dans Name, comme Contact par exemple, puis rédigez une description dans Description si nécessaire.
  4. Facultatif : Sélectionnez la Section dans laquelle vous souhaitez inclure le type de données.
  5. Si vous disposez déjà d'un exemple JSON de votre type de données, vous pouvez l'utiliser pour générer vos propriétés en cliquant sur Generate from JSON example.
  6. Saisissez votre exemple et cliquez sur Generate.

    Exemple

    Capture d'écran de l'utilisation d'un exemple JSON pour générer un type de données Contact.
    Toutes les propriétés dans l'exemple sont créées dans votre type de données.
  7. Pour ajouter des propriétés manuellement, sélectionnez un Type.
    Le type est object par défaut, mais vous pouvez cliquer pour afficher tous les types disponibles.
    Capture d'écran du type object developpé avec la liste des autres types disponibles.
  8. Cliquez sur Add property pour créer une nouvelle propriété et définissez les champs Name et Type.
  9. Facultatif : Placez le bouton Required sur Yes si la propriété est requise.
  10. Ajoutez une Description si nécessaire et cliquez sur more attributes pour ajouter plus d'informations à votre type de données.

    Exemple

    Exemple de définition de la propriété firstName, propriété requise de type String et décrite comme "Customer's first name".
  11. Ajoutez autant de propriétés que nécessaire, puis cliquez sur Save.

Dans cette section

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici