Konfigurere API-skabeloner

API-biblioteket til Business Central giver en forenklet fremstilling af de underliggende objekter. Det er ikke alle egenskaber i programmet, der vises ved hjælp af den tilknyttede API. På siden API-opsætning kan du definere skabeloner, der bruges til at angive tomme egenskaber for en enhed, når du opretter en BOGF-handling via API'et.

Hvis en konfigurationsskabelon defineres for vareobjektet, når der oprettes en ny post ved hjælp af varer-API'et, bliver egenskaber for den nye vare, der ikke er defineret i API-kaldet, f.eks. udfyldt med oplysninger fra den valgte skabelon. Hvis der f.eks. ikke er angivet en værdi i feltet Produktbogføringsgruppe ved hjælp af API'et, men der er angivet en værdi i den valgte skabelon, bliver værdien for bogføringsgruppen i skabelonen anvendt på den nye vare.

Opsætning af enhedsskabelonen

Hvis du vil bruge skabeloner med API-biblioteket, skal du først oprette og definere egenskaber for skabelonerne. Du kan oprette skabelonerne på siden Konfigurationsskabeloner. Du kan finde flere oplysninger i Overførsel af lokale data til Business Central Online i administration (kun engelsk version).

Tildele skabelonen til et API

Hvis du vil tildele en skabelon til en API, skal du udføre følgende trin.

Bemærk

API-skabeloner kan kun konfigureres med følgende API-sider: kontakter, countriesRegions, valutaer, debitorer, medarbejdere, itemCategories, paymentMethods, paymentTerms, shipmentMethods, unitsOfMeasure og leverandører.

1. Vælg ikon, skriv API-konfiguration, og vælg derefter det relaterede link.

2. Vælg Ny, og vælg derefter Rækkefølge-værdien for posten.

   Hvis der er valgt mere end én skabelon for et API (side-id), anvendes skabelonerne i den rækkefølge, der er defineret i kolonnen Rækkefølge.

   Når hver skabelon anvendes, anvendes feltværdier, der er defineret i skabelonen, kun til felter, der ikke allerede har en defineret værdi, enten direkte i API'et eller i en tidligere anvendt skabelon i rækkefølgen.

3. Vælg en værdi for Side-id:

   Dette er siden for det API, som skabelonen skal anvendes på. Side-ID-opslaget indeholder en oversigt over alle API'er, der er tilgængelige i biblioteket.

4. Vælg en værdi i feltet Skabelonkode.

   Skabelonkoden er koden for den skabelon, der blev defineret på siden Konfigurationsskabeloner. De definerede skabelonværdier anvendes på API'et.

5. I feltet Betingelser skal du angive, hvilken skabelon der skal anvendes.

   Den definerede skabelon anvendes på en ny post, der oprettes via API'et, hvis og kun hvis de betingelser, der er defineret i feltet Betingelser, opfyldes af de værdier, der allerede er defineret for den nye forekomst af enheden.

Se også

API-dokumentation
Udvikle Connect Apps til Business Central
Aktivere API'erne
Slutpunkter for API'erne
Opsætning

Find gratis e-learning-moduler til Business Central her