| Docs Hilfe
  AppSource  
Diese Seite druckenGesamtes Handbuch (Druckversion)
Docs  /  NVXAPIA API Automation  /  Arbeiten mit der App

Endpoint Definition


2025/06/30 • 8 Min. Lesedauer
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": ""
        }
        ..
    ]
}

Weitere Informationen



Feedback senden für
DE|EN Impressum
◀☰▶
△