API

2026/06/29 • 3 Min. Lesedauer

In diesem Thema

Endpoint
Auswertungsliste
Auswertung erstellen und abrufen
Berechtigungssatz
Weitere Informationen

Auswertungen können mit dem Excel Report Builder auch von extern über eine API erstellt werden. Die erstellte Excel-Datei wird dabei im Base64-Format zurückgeliefert. Damit eine Auswertung in der API sichtbar ist und ausgeführt werden kann, muss das Feld API-Zugriff zulassen auf der Excel-Auswertungskarte gesetzt sein. Weitere Informationen dazu finden Sie unter Auswertungen bearbeiten, Allgemein, Excel-Auswertung bearbeiten.

Hinweis

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

Endpoint

Um über die API auf den Excel Report Builder zuzugreifen, verwenden Sie die folgenden Informationen:

Publisher	navax
Group	excelReportBuilder
Version	v2.0
Endpoint	excelEvaluations

Auswertungsliste

Über ein GET-Request kann eine Liste aller Excel-Auswertungen abgerufen werden, bei denen ein API-Zugriff zugelassen ist. Aufbau der URL

https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/excelReportBuilder/v2.0/companies({id})/excelEvaluations

Beispiel

https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/excelReportBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/excelEvaluations

Ergebnis

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/excelReportBuilder/v2.0/$metadata#companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/excelEvaluations",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzMxMDQ5Njc5Nzc5MjgyNzY5NDIxOzAwOyc=\"",
            "code": "TEST",
            "description": "Test Evaluation",
            "comments": "API Test"
        },
        {
            "@odata.etag": "W/\"JzE3Ozc2NTU2NDM4NTIxNjcwNjE3MTswMDsn\"",
            "code": "TEST2",
            "description": "Test Evaluation 2",
            "comments": "API Test"
        }
    ]
}

Auswertung erstellen und abrufen

Über ein POST-Request kann eine Excel-Auswertung erstellt und abgerufen werden. Die erstellte Excel-Datei wird dabei im Base64-Format zurückgeliefert. Aufbau der URL

https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/excelReportBuilder/v2.0/companies({id})/excelEvaluations('{code}')/Microsoft.NAV.GetFileAsBase64

Beispiel

https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/excelReportBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/excelEvaluations('TEST')/Microsoft.NAV.GetFileAsBase64

Ergebnis

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/excelReportBuilder/v2.0/$metadata#Edm.String",
    "value": "UEsDBBQAAAAIADo7h1xFpqSDDAUAAFgZAAAYAAAAeGwvd29ya3NoZWV0cy9zaGVldDEueG1...gAAAAAA=="
}

Berechtigungssatz
Für die API steht folgender Berechtigungssatz zur Verfügung:
NCE, API	Excel Report Builder API Damit Excel-Auswertungen über die API ausgeführt werden können, muss dieser Berechtigungssatz der Microsoft Entra-Anwendung oder, bei einer On-Premises Installation, dem API-Benutzer hinzugefügt werden.