Configurer des modèles d’API

La bibliothèque d’API de 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 Paramètres API permet de définir des modèles qui sont 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 de l’article, les propriétés du nouvel article qui ne sont pas définies dans l’appel de l’API sont remplies à partir du modèle sélectionné. Si, par exemple, aucune valeur n’est définie pour le champ Groupe compta. produit via l’API, mais une valeur est définie dans le modèle sélectionné, la valeur du groupe comptabilisation définie dans le modèle est appliquée au nouvel article.

Configuration du modèle d’entité

Pour utiliser les 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 configuration. Pour plus d’informations, voir Migrer des données locales vers Business Central Online (en anglais uniquement) dans le contenu d’administration.

Affecter le modèle à une API

Pour affecter un modèle à une API, vous devez effectuer les actions suivantes.

Notes

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électionnez l’icône entrez Configuration API, puis choisissez le lien associé.

2. Choisissez Nouveau, puis la valeur Ordre pour l’enregistrement.

   Si plusieurs modèles sont sélectionnés pour une API (ID page), les modèles sont appliqués dans l’ordre défini dans la colonne Ordre.

   Lorsque chaque modèle est appliqué, les valeurs de champ définies dans le modèle sont uniquement appliquées aux champs sans valeur déjà définie, soit explicitement dans l’API ou dans un modèle précédemment appliqué dans l’ordre.

3. Sélectionnez une valeur ID page.

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

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

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

5. Dans le champ Conditions, spécifiez le modèle à appliquer.

   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 sont remplies par les valeurs déjà définies pour la nouvelle instance de l’entité.

Voir aussi

Documentation sur les API
Développer les Connect Apps pour Business Central
Activation des API
Points de terminaison des API
Administration

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