Handbuch als PDF speichern oder drucken  


NVXAPIA API Automation




Aktuelle Version: 1.1.4.0 ab Business Central 23.

Handbuch


Erstellungsdatum: 2025/07/04
Die aktuelle Version dieses Handbuchs finden Sie unter:

https://www.navax.app/help.php?AppID=NVXAPIA&L=de


☰ Inhaltsverzeichnis



Allgemein

  • App API Automation
    API Automation erweitert Microsoft Dynamics 365 Business Central um einen dynamische API Endpunkte die es ermöglichen Daten von Microsoft Dynamics 365 Business Central zu lesen, bearbeiten, einzufügen und löschen...

Einrichtung

  • API Automation Hub
    Zur Einrichtung der API-Automatisierung sind zwei Schritte erforderlich...
  • Zuordnungen
    Diese Anleitung beschreibt, wie Sie sogenannte Mappings in Microsoft Dynamics 365 Business Central einrichten. Ein Mapping legt fest, welche Tabellen und Felder für externe Abfragen verfügbar gemacht werden. Auf diese Weise können Sie steuern, welche Daten Drittanwendungen abrufen dürfen...

Arbeiten mit der App

  • Endpoint Definition
    Auf dieser Seite finden Sie eine Übersicht über die verschiedenen API-Endpunkte der API Automation. Diese Endpunkte ermöglichen den Zugriff auf und die Interaktion mit den Daten von Microsoft Dynamics 365 Business Central...
  • Arbeiten mit der App

Anhang

  • Verfügbare Endpunkte
  • Versionshinweise

Docs  /  NVXAPIA API Automation  /  Allgemein
App API Automation

API Automation erweitert Microsoft Dynamics 365 Business Central um einen dynamische API Endpunkte die es ermöglichen Daten von Microsoft Dynamics 365 Business Central zu lesen, bearbeiten, einzufügen und löschen.

Navigation

Felder, Aktionen, Seiten und Berichte, die aus der Erweiterung stammen, sind mit API Automation gekennzeichnet.

Docs  /  NVXAPIA API Automation  /  Einrichtung
API Automation Hub

Zur Einrichtung der API-Automatisierung sind zwei Schritte erforderlich. Bevor die Konfigurationen in Business Central vorgenommen werden können, müssen zunächst in Azure die notwendigen Einstellungen erfolgen, um die Kommunikation per Webservice mit Business Central zu ermöglichen. Alle relevanten Business Central Einrichtungen können direkt über die Seite API Automation Hub vorgenommen werden.

Einrichtung in Azure

Microsoft Entra Application

Um Anfragen an Business Central über die API zu stellen, wird eine weitere Entra-Anwendung benötigt, die über alle Berechtigungen für die API-Automatisierung verfügt.
  1. Entra-Anwendung in Azure erstellen
  2. Nachdem die Entra-Anwendung in Azure erstellt wurde, ist es auch notwendig, die Entra-Anwendung in Business Central zu erstellen. (wird ebenfalls im Link beschrieben)
  3. Wichtig: Für die API-Automatisierung ist es wichtig, das Berechtigungsset APIAPermissionsNVX sowie D365 READ hinzuzufügen.

API-Funktion Codeunit zu Web Services hinzufügen

Um den API-Endpunkt der API-Automatisierung zu veröffentlichen, muss die APIAFunctionsNVX Codeunit zu den Webdiensten hinzugefügt werden.
  1. Gehe zur Seite Web Services
  2. Klicke auf + Neu
  3. Verwende die folgenden Einstellungen:
    • Objekttyp: Codeunit
    • Objekt-ID: 64812
    • Service Name: APIAFunctionsNVX
  4. Veröffentliche den Endpunkt, indem du das Flag Veröffentlicht aktivierst
  5. Der neu erstellte Webservice sollte wie folgt aussehen:

Einrichtung in Business Central

Im zweiten Schritt erfolgen die weiteren Konfigurationen in Business Central. Über die Aktion Technische Einrichtungen vornehmen öffnet sich eine Übersicht aller relevanten Einrichtungsfelder. Hier wird zum einen die API-Automatisierung durch das Setzen des Flags Endpunkte aktivieren aktiviert. Zum anderen lässt sich im Feld Anzahl der Datensätze die maximale Anzahl an Datensätzen pro Request festlegen. Wird dieses Limit überschritten, muss die Verarbeitung über Paging erfolgen. Bleibt das Feld leer, gilt ein Standardwert von 20.000 Datensätzen pro Request.

Docs  /  NVXAPIA API Automation  /  Einrichtung
Zuordnungen

Diese Anleitung beschreibt, wie Sie sogenannte Mappings in Microsoft Dynamics 365 Business Central einrichten. Ein Mapping legt fest, welche Tabellen und Felder für externe Abfragen verfügbar gemacht werden. Auf diese Weise können Sie steuern, welche Daten Drittanwendungen abrufen dürfen.

Einrichtung eines Mappings

Das Einrichten eines Mappings erfolgt vollständig in Business Central und umfasst mehrere Schritte. Sie beginnen mit der Erstellung eines übergeordneten Mappings, anschließend definieren Sie die Tabellen und die einzelnen Felder, die Sie bereitstellen möchten.
  • Legen Sie einen eindeutigen Mapping-Code und eine Beschreibung an.
  • Fügen Sie alle Tabellen hinzu, die Sie freigeben möchten.
  • Verwenden Sie bei Bedarf die Funktion, alle Felder einer Tabelle automatisch zu übernehmen.
  • Bearbeiten oder ergänzen Sie die Feldzuordnung, um nur die gewünschten Felder bereitzustellen.
Nach Abschluss der Einrichtung kann das Mapping über den entsprechenden Mapping-Code in den Webservice-Abfragen verwendet werden. So stellen Sie sicher, dass nur die definierten Inhalte extern verfügbar sind. Weitere Informationen dazu finden Sie unter Arbeiten mit der App, Arbeiten mit der App.

Docs  /  NVXAPIA API Automation  /  Arbeiten mit der App
Endpoint Definition

Auf dieser Seite finden Sie eine Übersicht über die verschiedenen API-Endpunkte der API Automation. Diese Endpunkte ermöglichen den Zugriff auf und die Interaktion mit den Daten von Microsoft Dynamics 365 Business Central.

API Pages

In diesem Abschnitt finden Sie eine Übersicht über die verfügbaren API-Page. Diese Endpunkte erlauben es, strukturierte Daten aus Business Central in standardisierter Form abzurufen. Sie bilden die Grundlage für weiterführende Abfragen, da sie zentrale Informationen zu Tabellen und Feldern bereitstellen, die zur Konfiguration und Filterung weiterer Datenabfragen benötigt werden.

Alle Objekte mit Caption

Mit dem Endpunkt allObjWithCaptions können Sie Datensätze aus der Tabelle Alle Objekte mit Caption in Business Central abfragen.

Endpunkt: GET /api/navax/apia/v1.0/companies({{CompanyID}})/allObjWithCaptions
HTTP MethodeGET
URL
https://api.businesscentral.dynamics.com/v2.0/{{EnviromentName}}/api/navax/apia/v1.0/companies({{CompanyID}})/allObjWithCaptions
Beispielaufruf
GET https://api.businesscentral.dynamics.com/v2.0/TEST/api/navax/apia/v1.0/companies(00000000-0000-0000-0000-000000000000)/allObjWithCaptions
AntwortDer Endpunkt gibt die Details des angeforderten Datensatzes in JSON-Format zurück.

Felder

Mit dem Endpunkt fields können Sie Datensätze aus der Tabelle Felder in Business Central abfragen.

Endpunkt: GET /api/navax/apia/v1.0/companies({{CompanyID}})/fields
HTTP MethodeGET
URL
https://api.businesscentral.dynamics.com/v2.0/{{EnviromentName}}/api/navax/apia/v1.0/companies({{CompanyID}})/fields
Beispielaufruf
GET https://api.businesscentral.dynamics.com/v2.0/TEST/api/navax/apia/v1.0/companies(00000000-0000-0000-0000-000000000000)/fields
AntwortDer Endpunkt gibt die Details des angeforderten Datensatzes in JSON-Format zurück.

Tipp

Die Endpunkte für Alle Objekte mit Caption und Felder können als Basis verwendet werden um für die nachfolgenden Abfrage schon gewisse Daten vorzuspeichern. Feld-IDs und Tabellen-IDs werden in den Funktionen verwendet für die Filterung der Datensätze.

API Functions

Die folgenden Funktionen bieten Ihnen weiterführende Möglichkeiten zur Interaktion mit den Daten in Business Central. Im Gegensatz zu den einfachen Seiten-Endpunkten erlauben diese Funktionen eine gezielte Abfrage komplexer Strukturen, das Filtern nach spezifischen Kriterien sowie das Abrufen von Daten aus mehreren Mandanten gleichzeitig. Die Funktionen lassen sich flexibel anpassen und sind insbesondere für dynamische Szenarien oder Analysen in externen Systemen wie Power BI geeignet.

Wichtig

Die Beispiel URLs in den einzelnen Request setzt voraus, dass bei der Einrichtung die benötigte Codeunit 64812 APIAFunctionsNVX mit dem Namen APIAFunctionsNVX eingerichtet wurde. Weitere Informationen dazu finden Sie unter Einrichtung, API Automation Hub.

Tabellenstruktur aus BC lesen

Mit dem Endpunkt GetTableStructure können Sie die Struktur von Tabellen aus Business Central abfragen.

Endpunkt: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableStructure?company={{CompanyName}}
HTTP MethodePOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableStructure?company={{CompanyName}}
Benötigte Parameter
  • tableID: Die ID der Tabelle die abgefragt werden will.
Beispielaufruf
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableStructure?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "18"
}
AntwortDer Endpunkt gibt die Details der abgefragten Tabelle in JSON String-Format zurück.
Beispielantwort (konvertiert in JSON) 
{
    "table": 18,
    "values": [
        {
            "No.": {
                "no": 1,
                "type": "",
                "length": 20,
                "typeName": "Code20",
                "optionString": "",
                "IsPartOfPrimaryKey": true
            },
            "Name": {
                "no": 2,
                "type": "",
                "length": 100,
                "typeName": "Text100",
                "optionString": "",
                "IsPartOfPrimaryKey": false
            },
            ...
        }
    ]
}

Daten aus BC lesen

Mit dem Endpunkt GetTableData können Sie Daten ohne Tabellenfilter aus Business Central abfragen.

Endpunkt: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableData?company={{CompanyName}}
HTTP MethodePOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableData?company={{CompanyName}}
Benötigte Parameter
  • tableID: Die ID der Tabelle die abgefragt werden will.
  • fieldFilter: Ein Filter der benötigten Feld-IDs aus der Tabelle.
Beispielaufruf
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableData?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "18",
    "fieldFilter": "1|2|5..10"
}
AntwortDer Endpunkt gibt die Details der abgefragten Tabelle in JSON String-Format zurück.
Beispielantwort (konvertiert in JSON) 
{
    "table": 18,
    "values": [
        {
            "company": "",
            "No.": "10000",
            "Name": "Adatum Corporation",
            "Address": "Station Road, 21",
            "Address 2": "",
            "City": "Wien",
            "Contact": "",
            "Phone No.": "",
            "Telex No.": ""
        },
        {
            "company": "",
            "No.": "20000",
            "Name": "Trey Research",
            "Address": "Southwark Bridge Rd, 91-95",
            "Address 2": "",
            "City": "Dürnstein",
            "Contact": "Leonie Fischer",
            "Phone No.": "",
            "Telex No.": ""
        }
    ]
}

Daten aus BC mit Tabellenfilter lesen

Mit dem Endpunkt GetTableDataWithFilter können Sie Daten mit Tabellenfilter aus Business Central abfragen.

Endpunkt: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataWithFilter?company={{CompanyName}}
HTTP MethodePOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataWithFilter?company={{CompanyName}}
Benötigte Parameter
  • tableID: Die ID der Tabelle die abgefragt werden will.
  • fieldFilter: Ein Filter der benötigten Feld-IDs aus der Tabelle.
  • tableFilter: Definiert die Filterung der Tabelle.
Beispielaufruf
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableDataWithFilter?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "18",
    "fieldFilter": "1|2|3|4",
    "tableFilter": "Sorting(No.) Order(Ascending) Where(No.=Filter(10000))"
}
AntwortDer Endpunkt gibt die Details der abgefragten Tabelle in JSON String-Format zurück.
Beispielantwort (konvertiert in JSON) 
{
    "table": 18,
    "values": [
        {
            "company": "",
            "No.": "10000",
            "Name": "Adatum Corporation",
            "Search Name": "ADATUM CORPORATION",
            "Name 2": ""
        }
    ]
}

Wichtig

Pro Abfrage können maximal 10000 Datensätze zurückgeliefert werden. Für den Fall, dass mehr Daten in der Abfrage enthalten sind, muss die Abfrage über Paging abgearbeitet werden. Um Paging auszuführen wird ein zusätzliches Attribut zurückgeliefert nextPageLink. Dieses Attribut liefert den Primary Key des nächsten Datensatzes und kann somit für die Filterung verwendet werden.

Daten aus BC mit BC-Zuordnung lesen

Mit dem Endpunkt GetTableDataFromMapping können Sie Daten, die in den BC-Zuordnungen eingerichtet wurden, aus Business Central abfragen.

Endpunkt: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataFromMapping?company={{CompanyName}}
HTTP MethodePOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataFromMapping?company={{CompanyName}}
Benötigte Parameter
  • tableID: Die ID der Tabelle die abgefragt werden will.
  • mappingCode: Der Code der BC-Zuordnungen die abgefragt werden will.
Beispielaufruf
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableDataFromMapping?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "18",
    "mappingCode": "POWER BI"
}
AntwortDer Endpunkt gibt die Details der abgefragten Tabelle in JSON String-Format zurück.
Beispielantwort (konvertiert in JSON) 
{
    "table": 18,
    "values": [
        {
            "company": "",
            "No.": "10000",
            "Name": "Adatum Corporation",
            "Name 2": ""
        }
        ..
    ]
}

Daten aus BC von allen Mandanten lesen

Mit dem Endpunkt GetTableDataAllCompanies können Sie Daten über alle Mandanten aus Business Central abfragen.

Endpunkt: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataAllCompanies?company={{CompanyName}}
HTTP MethodePOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataAllCompanies?company={{CompanyName}}
Benötigte Parameter
  • tableID: Die ID der Tabelle die abgefragt werden will.
  • fieldFilter: Ein Filter der benötigten Feld-IDs aus der Tabelle.
  • allCompanies: Gibt an, ob die Daten aus allen Mandanten geholt werden sollen.
  • modifiedAt: Kann die Daten vorfiltern auf ein bestimmte Änderungsdatum.
Beispielaufruf
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableDataAllCompanies?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "27",
    "fieldFilter": "1",
    "allCompanies": "false",
    "modifiedAt": ""
}
AntwortDer Endpunkt gibt die Details der abgefragten Tabelle in JSON String-Format zurück.
Beispielantwort (konvertiert in JSON) 
{
    "table": 18,
    "values": [
        {
            "company": "",
            "No.": "10000",
            "Name": "Adatum Corporation",
            "Name 2": ""
        }
        ..
    ]
}

Docs  /  NVXAPIA API Automation  /  Arbeiten mit der App
Arbeiten mit der App

iheader Diese App ermöglicht es, Daten aus Microsoft Dynamics 365 Business Central flexibel auszulesen und in externe Systeme zu integrieren. Sie bietet hierfür verschiedene Webservice-Endpunkte an, die entweder für technische Integrationen oder für den Einsatz in definierten, vorbereiteten Mappings verwendet werden können.

Technische Nutzung

Entwickler und Administratoren können direkt auf die verfügbaren Webservices zugreifen, um Informationen zu Tabellenstrukturen und Feldern zu erhalten. Diese Basisdaten sind notwendig, um Abfragen korrekt zu konfigurieren. Dazu sollten Sie zunächst prüfen, welche Tabellen und Felder in Ihrem Business Central Mandanten vorhanden sind. Sie nutzen hierzu die bereitgestellten Endpunkte, um:
  • eine Liste aller Tabellen inklusive ihrer Bezeichnungen abzurufen
  • alle Felder einer bestimmten Tabelle zu identifizieren
Nachdem Sie die relevanten IDs der Tabellen und Felder ermittelt haben, können Sie in Ihren Abfragen genau festlegen, welche Inhalte zurückgegeben werden sollen. Diese Abfragen lassen sich mit Filtern kombinieren, um z. B. bestimmte Datensätze oder Zeiträume zu selektieren. Weitere Informationen dazu finden Sie unter Arbeiten mit der App, Endpoint Definition.

Nutzung mit BC Einrichtung

Für Anwender, die keinen direkten Zugriff auf alle Rohdaten gewähren möchten, besteht die Möglichkeit, sogenannte Mappings einzurichten. Mappings legen fest, welche Tabellen und Felder für externe Abfragen freigegeben werden. So kann in Business Central genau bestimmet werden, welche Daten externen Anwendungen oder Partnern zur Verfügung stehen. Nach dem Einrichten eines Mappings erhalten Techniker einen Mapping-Code. Dieser Code wird in Abfragen verwendet, um ausschließlich die in diesem Mapping definierten Daten abzufragen. Auf diese Weise behalten Sie als Kunde stets die volle Kontrolle darüber, welche Informationen exportiert werden. Weitere Informationen dazu finden Sie unter Arbeiten mit der App, Endpoint Definition.

Docs  /  NVXAPIA API Automation  /  Anhang
Verfügbare Endpunkte

Wichtig

Um eine Verbindung zu einem API-Endpunkt von Business Central herzustellen, können Sie folgende URL verwenden. https://api.businesscentral.dynamics.com/v2.0/{{Enviroment_Name}}/api/navax/apia/v1.0/companies({{CompanyID}})/{{EntitySetName}}

Verfügbare Endpunkt

Tabellenname Entity Set Name
Alle Objekte mit Caption allObjWithCaptions
Felder fields
Funktion Entity Set Name
Tabellenstruktur aus BC lesen GetTableStructure
Daten aus BC lesen GetTableData
Daten aus BC mit Tabellenfilter lesen GetTableDataWithFilter
Daten aus BC mit BC-Zurordnung lesen GetTableDataFromMapping
Daten aus BC von allen Mandanten lesen GetTableDataAllCompanies
Daten in BC verändern UpdateRecord

Tipp

Sie können die Webservices auch über die Seite Webdienste aufrufen und direkt über die OData V4 URL verbinden.
Weitere Informationen dazu finden Sie unter Arbeiten mit der App, Endpoint Definition.

Docs  /  NVXAPIA API Automation  /  Anhang
Versionshinweise

Möchten Sie wissen, was sich in der Erweiterung geändert hat?
Nachfolgend finden Sie eine Übersicht über die neuen Funktionen und Änderungen, die in den Updates vorgenommen wurden. Build-Übersicht in DevOps

NVXAPIA 1.1.4.0

ab Business Central 23
2025/06/30

  • Ursprungsversion

  Handbuch als PDF speichern oder drucken  
DE|EN Impressum