| Docs Hilfe
  AppSource  
Docs  /  App  /  XML Builder  /  Informationen für Entwickler

 API


2026/05/19 • 3 Min. Lesedauer
Dateien können mit dem XML Builder auch von extern über eine API erstellt werden. Die erstellte Datei wird dabei im Base64-Format zurückgeliefert. Damit ein Schema in der API sichtbar ist bzw. die Datei über die API erstellt werden kann, muss das Feld API-Zugriff zulassen für das XML-Schema gesetzt sein. Weitere Informationen dazu finden Sie unter Arbeiten mit der App, XML Builder Schemata.

Hinweis

Falls notwendig können Sie den API-Zugriff auch jederzeit in der XML Builder Einrichtung komplett deaktivieren. Weitere Informationen dazu finden Sie unter Einrichtung, XML Builder Einrichtung.

Endpoint

Um über die API auf den XML Builder zuzugreifen, verwenden Sie die folgenden Informationen:
Publishernavax
GroupxmlBuilder
Versionv2.0
EndpointxmlSchemas

Liste der XML-Schemata

Über ein GET-Request kann eine Liste aller XML-Schemata abgerufen werden, bei denen ein API-Zugriff zugelassen ist. Aufbau der URL https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/xmlBuilder/v2.0/companies({id})/xmlSchemas Beispiel https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas Ergebnis
{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/$metadata#companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzMxMDQ5Njc5Nzc5MjgyNzY5NDIxOzAwOyc=\"",
            "code": "CUST",
            "description": "Debitoren inkl. Posten",
            "comments": "API Test",
            "filter": "{ \"No.\": \"Code\", \"Salesperson Code\": \"Code\" }"
        },
        {
            "@odata.etag": "W/\"JzE3Ozc2NTU2NDM4NTIxNjcwNjE3MTswMDsn\"",
            "code": "SINV",
            "description": "Verkaufsrechnung",
            "comments": "API Test",
            "filter": "{ \"No.\": \"Code\" }"
        }
    ]
}

Datei erstellen und abrufen

Über ein POST-Request kann die Datei für ein Schema erstellt und abgerufen werden. Die erstellte Datei wird dabei im Base64-Format zurückgeliefert. Aufbau der URL https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/xmlBuilder/v2.0/companies({id})/xmlSchemas('{code}')/Microsoft.NAV.GetFileAsBase64 Beispiel https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas('TEST')/Microsoft.NAV.GetFileAsBase64 Ergebnis
{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/$metadata#Edm.String",
    "value": "UEsDBBQAAAAIADo7h1xFpqSDDAUAAFgZAAAYAAAAeGwvd29ya3NoZWV0cy9zaGVldDEueG1...gAAAAAA=="
}

Filter setzen

TODO

Berechtigungssatz

Für die API steht folgender Berechtigungssatz zur Verfügung:
NVXXML, APIXML Builder API Damit Dateien über die API erstellt werden können, muss dieser Berechtigungssatz der Microsoft Entra-Anwendung oder, bei einer On-Premises Installation, dem API-Benutzer hinzugefügt werden.

Weitere Informationen




Feedback senden für
DE|EN Impressum