Sdílet prostřednictvím


Konfigurace šablon API

Knihovna API pro Business Central poskytuje zjednodušenou reprezentaci základních entit. Všechny vlastnosti v aplikaci nejsou vystaveny prostřednictvím přidruženého rozhraní API. Stránka Nastavení rozhraní API umožňuje definovat šablony, které se používají k naplnění prázdných vlastností entity, když vytvoříte akci POST prostřednictvím rozhraní API.

Pokud je například pro entitu položky definována šablona konfigurace, při vytvoření nového záznamu položky prostřednictvím rozhraní API položek se všechny vlastnosti nové položky, které nejsou definovány ve volání rozhraní API, vyplní z vybrané šablony. Pokud například není definována žádná hodnota pro pole Gen. Prod. Skupina zaúčtování prostřednictvím rozhraní API, ale ve vybrané šabloně je definována hodnota, pak se na novou položku použije hodnota skupiny zaúčtování definovaná v šabloně.

Nastavení šablony entity

Chcete-li používat šablony s knihovnou API, musíte nejprve nastavit a definovat vlastnosti šablon. Tyto šablony můžete nastavit na stránce Šablony konfigurace. Další informace naleznete v části Migrace místních dat do Business Central Online (pouze v angličtině) v obsahu správy.

Přiřazení šablony k rozhraní API

Chcete-li přiřadit šablonu k rozhraní API, musíte provést následující kroky.

Poznámka

Šablony API lze nastavit pouze pro následující stránky API: kontakty, countriesRegions, měny, zákazníci, zaměstnanci, itemCategories, paymentMethods, paymentTerms, shipmentMethods, unitsOfMeasure a dodavatelé.

  1. Zvolte ikonu Žárovka, která otevírá funkci Řekni mi., zadejte Nastavení rozhraní API a zvolte související odkaz.

  2. Vyberte Nový a poté vyberte hodnotu Objednávka pro záznam.

    Pokud je pro API (ID stránky) vybrána více než jedna šablona, ​​šablony se použijí v pořadí definovaném ve sloupci Objednávka.

    Při použití každé šablony se hodnoty polí definované v šabloně použijí pouze na pole, která ještě nemají definovanou hodnotu, a to buď explicitně v rozhraní API, nebo v dříve použité šabloně v objednávce.

  3. Vyberte hodnotu ID stránky.

    Toto je stránka pro rozhraní API, na které bude šablona použita. Vyhledávací kód ID stránky poskytuje seznam všech rozhraní API dostupných v knihovně.

  4. Vyberte hodnotu v poli Kód šablony.

    Kód šablony je kód pro šablonu, který byl definován na stránce Šablony konfigurace. Definované hodnoty šablony se použijí na rozhraní API.

  5. V poli Podmínky zadejte, která šablona se má použít.

    Definovaná šablona se použije na nový záznam vytvořený prostřednictvím rozhraní API tehdy a pouze tehdy, pokud podmínky definované v poli Podmínky splňují hodnoty již definované pro novou instanci entity.

Viz také

Dokumentace API
Vývoj aplikací Connect Apps pro Business Central
Povolení rozhraní API
Koncové body pro rozhraní API
Správa

Zde najdete bezplatné e-learningové moduly pro Business Central