API Vorlagen konfigurieren

Die API-Bibliothek für Business Central bietet eine vereinfachte Darstellung der zugrunde liegenden Einheiten. Alle Eigenschaften der Anwendung werden nicht durch die zugeordnete API bereitgestellt. Die Seite API Einrichten ermöglicht Ihnen, Vorlagen festzulegen, die verwendet werden, um leere Eigenschaften auf eine Einheit zu füllen, wenn Sie eine Beitragsaktion durch die API erstellen.

Wenn beispielsweise eine Konfigurationsvorlage für die Artikeleinheit definiert ist, wenn ein Datensatz des neuen Artikels um die API Artikel erstellt wird, werden Eigenschaften für den neuen Artikel, die nicht im API-Aufruf definiert sind, aus der ausgewählten Vorlage definiert. Wenn beispielsweise kein Wert für das Feld Gen. Prod. Buchungsgruppe durch die API definiert wird, aber ein Wert in der ausgewählten Vorlage definiert ist, wird der Wert, der in der Vorlage festgelegt wird, vom neuen Artikel übernommen.

Einrichten der Einheiten-Vorlage

Um Vorlagen mit der API-Bibliothek zu verwenden, müssen Sie verschiedene Eigenschaften für die Vorlagen anlegen und definieren. Sie können diese Vorlagen auf der Seite Konfigurationsvorlagen einrichten. Weitere Informationen finden Sie unter Lokale Daten zu Business Central Online migrieren (nur in englischer Sprache) im Verwaltungsinhalt.

Weisen Sie die Vorlage zu einer API zu

Um eine Vorlage zu einer API zuzuordnen, müssen Sie folgende Schritte durchführen.

Hinweis

API-Vorlagen können nur mit den folgenden API-Seiten eingerichtet werden: contacts, countriesRegions, currencies, customers, employees, itemCategories, paymentMethods, paymentTerms, shipmentMethods, unitsOfMeasure und vendors.

  1. Wählen Sie das Symbol Glühbirne, die die „Wie möchten Sie weiter verfahren“-Funktion öffnet aus, geben Sie API-Einrichtung ein, und wählen Sie den zugehörigen Link aus.

  2. Wählen Sie Neu und dann den Wert Auftrag für den Datensatztyp aus.

    Wenn es mehr als eine Vorlage gibt, die für eine API ausgewählt wird (Seiten-ID), werden die Vorlagen im Auftrag angewendet, der in der Spalte Auftrag definiert ist.

    Wenn jeder Vorlage übernommen wird, werden die Feldwerte, die in der Vorlage definiert werden, nur zu den Feldern, die nicht bereits einen explizit definierten Wert aufweisen, entweder explizit der API oder einer zuvor zugewiesenen Vorlage im Auftrag zugeordnent.

  3. Wählen Sie einen PageID Wert. aus.

    Dieses ist die Seite für die API, für die die Vorlage angewendet wird. Die Seiten-ID Suche bietet eine Übersicht aller APIs, die in derselben Bibliothek verfügbar sind.

  4. Wählen Sie im Feld Vorlagencode einen Wert aus.

    Der Vorlagencode ist der Code für die Vorlage, die auf der Seite Konfigurationsvorlagen definiert wurde. Die definierten Vorlagenwerte werden auf die API übernommen.

  5. In dem Feld Bedingungen geben Sie an, welche Vorlage ausgeglichen werden soll.

    Die definierte Vorlage wird in einen neuen Datensatz angewendet, der durch die API erstellt wird, wenn die Bedingungen, die im Bedingungen Feld definiert werden, durch die Werte erfüllt sind, die bereits für die neue Instanz der Einheit definiert werden.

Siehe auch

API-Dokumentation
Connect Apps für Business Central entwickeln
Aktivieren der APIs
Endpunkte für die APIs
Verwaltung

Kostenlose E-Learning-Module für Business Central finden Sie hier