Przejdź do treści

© navision.pl | Opracowano na podstawie: Microsoft Learn (CC BY 4.0)

Konfigurowanie szablonów API

Biblioteka API dla Business Central zapewnia uproszczoną reprezentację podstawowych encji. Nie wszystkie właściwości w aplikacji są udostępniane przez powiązane API. Strona Konfiguracja API umożliwia definiowanie szablonów używanych do wypełniania pustych właściwości encji podczas tworzenia akcji POST przez API.

Na przykład, jeśli szablon konfiguracji jest zdefiniowany dla encji zapasu, podczas tworzenia nowego rekordu zapasu przez API zapasów, wszystkie właściwości nowego zapasu, które nie są zdefiniowane w wywołaniu API, zostaną wypełnione z wybranego szablonu. Jeśli na przykład przez API nie zdefiniowano wartości dla pola Ogólna gr. księgowa zapasu, ale wartość jest zdefiniowana w wybranym szablonie, wówczas wartość grupy księgowej zdefiniowana w szablonie zostanie zastosowana do nowego zapasu.

Konfigurowanie szablonu encji

Aby używać szablonów z biblioteką API, należy najpierw skonfigurować i zdefiniować właściwości szablonów. Szablony te można skonfigurować na stronie Szablony konfiguracji. Aby uzyskać więcej informacji, zobacz Migracja danych lokalnych do Business Central Online (tylko w języku angielskim) w treści administracyjnej.

Przypisywanie szablonu do API

Aby przypisać szablon do API, należy wykonać następujące kroki.

Uwaga

Szablony API można skonfigurować tylko dla następujących stron API: contacts, countriesRegions, currencies, customers, employees, itemCategories, paymentMethods, paymentTerms, shipmentMethods, unitsOfMeasure i vendors.

  1. Wybierz Szukaj (Alt+Q) Szukaj w prawym górnym rogu, wprowadź Konfiguracja API i wybierz powiązane łącze.

  2. Wybierz Nowy, a następnie wybierz wartość Kolejność dla rekordu.

    Jeśli dla API (identyfikator strony) wybrano więcej niż jeden szablon, szablony są stosowane w kolejności zdefiniowanej w kolumnie Kolejność.

    Podczas stosowania każdego szablonu wartości pól zdefiniowane w szablonie są stosowane tylko do pól, które nie mają jeszcze zdefiniowanej wartości, ani jawnie w API, ani we wcześniej zastosowanym szablonie według kolejności.
    3. Wybierz wartość Identyfikator strony.

    Jest to strona API, do której zostanie zastosowany szablon. Wyszukiwanie Identyfikator strony udostępnia listę wszystkich interfejsów API dostępnych w bibliotece. 4. Wybierz wartość w polu Kod szablonu.

    Kod szablonu to kod szablonu zdefiniowanego na stronie Szablony konfiguracji. Zdefiniowane wartości szablonu są stosowane do API.
    5. W polu Warunki określ, który szablon powinien zostać zastosowany.

    Zdefiniowany szablon jest stosowany do nowego rekordu utworzonego przez API wtedy i tylko wtedy, gdy warunki zdefiniowane w polu Warunki są spełnione przez wartości już zdefiniowane dla nowej instancji encji.

Powiązane informacje

API Documentation
Develop Connect Apps for Business Central
Enabling the APIs
Endpoints for the APIs
Zadania administracyjne w Business Central

Znajdź bezpłatne moduły e-learningowe dla Business Central tutaj