Configurer les modèles d'API

La bibliothèque d'API pour Business Central fournit une représentation simplifiée des entités sous-jacentes. Toutes les propriétés de l'application ne sont pas exposées via l'API associée. La page Configuration de l'API page vous permet de définir des modèles utilisés pour remplir les propriétés vides d'une entité lorsque vous créez une action POST via l'API.

Par exemple, si un modèle de configuration est défini pour l'entité article, lorsqu'un nouvel enregistrement d'article est créé via l'API des articles, toutes les propriétés du nouvel article qui ne sont pas définies dans l'appel d'API seront remplies à partir du modèle sélectionné. Si, par exemple, aucune valeur n'est définie pour le champ Groupe de report produit général champ via l'API, mais qu'une valeur est définie dans le modèle sélectionné, alors la valeur du groupe de report définie dans le modèle sera appliquée au nouvel article.

Configuration du modèle d'entité

Pour utiliser des modèles avec la bibliothèque d'API, vous devez d'abord configurer et définir les propriétés des modèles. Vous pouvez configurer ces modèles sur la page Modèles de configuration page. Pour plus d'informations, consultez Migrer les données locales vers Business Central en ligne (en anglais seulement) dans le contenu d’administration.

Associer le modèle à une API

Pour associer un modèle à une API, vous devez suivre les étapes suivantes.

Remarque

Remarque:
Les modèles d'API ne peuvent être configurés qu'avec les pages d'API suivantes : contacts, countriesRegions, currencies, customers, employees, itemCategories, paymentMethods, paymentTerms, shipmentMethods, unitsOfMeasure et vendors.

1. Sélectionner Rechercher (Alt+Q) dans le coin supérieur droit, saisissez Configuration de l'API, et choisissez le lien connexe.

2. Choisissez Nouveau, puis choisissez le Commande valeur pour l'enregistrement.

   Si plusieurs modèles sont sélectionnés pour une API (ID de page), les modèles sont appliqués dans l'ordre défini dans le Commande colonne.

   Lorsque chaque modèle est appliqué, les valeurs de champ définies dans le modèle ne sont appliquées qu'aux champs qui n'ont pas encore de valeur définie, que ce soit explicitement dans l'API ou dans un modèle appliqué précédemment dans l'ordre.

3. Sélectionnez un ID de page valeur.

   Il s'agit de la page de l'API à laquelle le modèle sera appliqué. La page ID de page recherche fournit une liste de toutes les API disponibles dans la bibliothèque.

4. Sélectionnez une valeur dans le champ Code du modèle champ.

   Le code du modèle est le code du modèle défini sur la page Modèles de configuration page. Les valeurs de modèle définies sont appliquées à l'API.

5. Dans la Conditions champ, spécifiez quel modèle doit être appliqué.

   Le modèle défini est appliqué à un nouvel enregistrement créé via l'API si, et seulement si, les conditions définies dans le champ Conditions champ sont remplies par les valeurs déjà définies pour la nouvelle instance de l'entité.

Informations connexes

Documentation de l'API
Développer des applications Connect pour Business Central
Activation des API
Points de terminaison des API
Administration

Trouvez des modules d'apprentissage en ligne gratuits pour Business Central ici