SharePoint Export via Graph API

This interface allows integration with Microsoft's official SharePoint Graph API to communicate with a SharePoint directory.
A registered Microsoft Azure application is required for this.

Integrated Services of the Graph API

• Upload documents to a pre-defined SharePoint directory.

Access Permissions in Microsoft Azure

Required Applications

Create two new applications in Microsoft Azure.
One is used for administrative purposes, the other for the user itself.

To grant the following permissions, a user with administrative rights in Microsoft Azure is required.

• The admin application requires the API permission Sites.FullControl.All.
• The user application requires the API permission Sites.Selected.

In the admin application, a user must be created in the Certificates & secrets menu.
This user is required to grant the necessary permissions to the user application.

_{Abbildung - Registrierte Microsoft Applikation "Neue SharePoint Applikation"}

Permissions for the User Application

For this section, you will need the data from the previously created admin application.

The user application must be explicitly granted permissions to the desired SharePoint site.
For this, the ID of the SharePoint site is required.

Unfortunately, as of March 2025, it is not possible to retrieve the SharePoint site ID through the graphical interface.

Login

First, you need a Bearer Token to authenticate with the API. This is done using the following request:

• URL: https://login.microsoftonline.com/<TENANT_ID>/oauth2/v2.0/token

• HTTP Method: POST

• Request Body Type: form-data

• Request Body:

  • client_id:<CLIENT_ID>

  • client_secret:<CLIENT_SECRET>

  • grant_type:client_credentials

  • scope:https://graph.microsoft.com/.default

Instead of <TENANT_ID>, <CLIENT_ID>, and <CLIENT_SECRET>, you must use your respective credentials.You can find these credentials in the sections "Feld Tenant Id", "Feld Client Id" and"Feld Client Secret" of this article.

Here is the corresponding cURL command:

curl --location 'https://login.microsoftonline.com/<TENANT_ID>/oauth2/v2.0/token' \--form 'client_id="<CLIENT_ID>"' \--form 'client_secret="<CLIENT_SECRET>"' \--form 'grant_type="client_credentials"' \--form 'scope="https://graph.microsoft.com/.default"'

Retrieve Site ID

The Site ID is required for the permission request and can be obtained as follows:

• URL: https://graph.microsoft.com/v1.0/sites/<TENANT>.sharepoint.com/sites/<NAME>
• HTTP Methode: GET
• Header: "Authorization: Bearer <BEARER_TOKEN>"

Here is the corresponding cURL command:

curl --location 'https://graph.microsoft.com/v1.0/sites/<TENANT>.sharepoint.com:/sites/<NAME>' \--header 'Authorization: Bearer <BEARER_TOKEN>'

The response from this request is a bit more complex to read. Here's an example:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#sites/$entity",
  "createdDateTime": "2025-03-13T00:11:15.033Z",
  "description": "TestDescription",
  "id": "<TENANT>.sharepoint.com,808dec17-aa6d-4158-a9fe-8caa8d909dff,81f7ad14-65ae-46c2-b0fc-10602e9401cc",
  "lastModifiedDateTime": "2025-03-13T07:07:19Z",
  "name": "TestName",
  "webUrl": "https://<TENANT>.sharepoint.com/sites/<SITE_NAME>",
  "displayName": "TestName",
  "root": {},
  "siteCollection": {
    "hostname": "<TENANT>.sharepoint.com"
  }
}

In this case, the Site ID is the value 808dec17-aa6d-4158-a9fe-8caa8d909dff.
It is located in the "id" field of the response and is the middle part of the value when the string is split by commas.

Grant Permissions

To grant access permissions, you need the client ID and the name of the user application.
Insert them in place of <USER_APPLICATION_CLIENT_ID> and <USER_APPLICATION_NAME>.
Write permissions also include read permissions.

• URL: https://graph.microsoft.com/v1.0/sites/<SITE_ID>/permissions
• HTTP Methode: POST
• Request Body Type: JSON
• Request Body:
  

  • {
      "roles": [
        "write"
      ],
      "grantedToIdentities": [
        {
          "application": {
            "id": "<USER_APPLICATION_CLIENT_ID>",
            "displayName": "<USER_APPLICATION_NAME>"
          }
        }
      ]
    }

Here is the corresponding cURL command:

curl --location 'https://graph.microsoft.com/v1.0/sites/<SITE_ID>/permissions' \
--header 'Authorization: Bearer <BEARER_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
  "roles": ["write"],
  "grantedToIdentities": [{
    "application": {
      "id": "<NUTZER_APPLIKATION_CLIENT_ID>",
      "displayName": "<NUTZER_APPLIKATION_NAME>"
    }
  }]
}'

Der Server gibt im Erfolgsfall eine Response mit dem Statuscode 201 zurück.
Da der Statuscode aussagekräftig genug ist, kann der Inhalt der Response vernachlässigt werden.

Konfiguration

Um diese Schnittstelle zu verwenden und Aktionen auszuführen, muss an der Squeeze Dokumentenklasse eine Export-Schnittstelle definiert werden.
Die benötigten Zugangsdaten entnehmen Sie aus der Nutzer-Applikation.

Authentifizierung

_{Abbildung - Export Interface SharePoint GraphAPI (WIP)}

Feld Beschreibung

Für das Export Interface kann ein Name angegeben werden, im Feld Beschreibung.

Feld Host

In diesem Feld wird die Adresse zur SharePoint Seite hinterlegt. Diese hat folgendes Muster: <TENANT>.sharepoint.com/sites/<NAME>.

Feld Tenant Id

Die Tenant Id befindet sich in der Übersicht einer registrierten App. Eine Auflistung dieser Apps finden sie hier.
Um die Liste zu sehen müssen Sie eingeloggt sein.

Die Tenant Id wird auf der Seite auch "Directory (tenant) ID".

Feld Client Id

Die Tenant Id befindet sich in der Übersicht einer registrierten App. Eine Auflistung dieser Apps finden sie hier.
Um die Liste zu sehen müssen Sie eingeloggt sein.

Hier wird sie auch unter dem Begriff "Application (client) ID" geführt.

Feld Client Secret

Die Tenant Id befindet sich in der Übersicht einer registrierten App. Eine Auflistung dieser Apps finden sie hier.
Um die Liste zu sehen müssen Sie eingeloggt sein.

Das Client Secret wird innerhalb der registrierten App hinterlegt. Das dafür nötige Menü finden Sie in, in der ausgewählten App, unter dem Menü "Certificates & secrets".

Für das Erstellen eines Secrets müssen sie lediglich eine aussagekräftige Beschreibung angeben, und den Zeitraum, in welchem das Secret valide ist.
Das Client Secret wird bei Microsoft unter "Secret Value" geführt. Diese Information wird nur einmalig angezeigt, aus diesem Grund sollte es in einer sicheren Umgebung gespeichert werden.
Verwechseln Sie das Client Secret nicht mit "Secret Value".

Feld Entity

Über die Entity wird der Service ausgewählt, welchen Sie verwenden möchten:

• SharePoint Document Export
  • Service um ein Dokument hochzuladen

Feld Export Folder Structure

Dateien werden alle in das Home Verzeichnis des SharePoint Verzeichnisses hochgeladen.
Um zu spezifizieren, in welche Verzeichnis Struktur ein Dokument abgelegt werden soll, können in dieser Auswahlliste mehrere Felder ausgewählt werden.
Die Felder werden durch ihre in SQUEEZE erkannten Daten ersetzt. So könnte beispielsweise die Auswahl des Feldes "IBAN" dazu führen, dass ein Dokument in das Verzeichnis der erkannten IBAN abgelegt wird (nicht in einem Verzeichnis mit dem Namen "IBAN").

Feld Drive

Bei der korrekten Eingabe von Host, Tenant ID, Client ID und dem Client Secret, wird im Feld Drive eine Liste von möglichen Verzeichnissen aufgeführt, welches als Home Verzeichnis des SharePoints dienen soll, das Sie auswählen müssen.

Feld Create Folder Structure

Diese Funktion erstellt beim Wert "Ja" ein Pfad Verzeichnis, auch wenn es vorher nicht existiert.
Sollte das Verzeichnis bereits existieren wird kein neues Verzeichnis erstellt.
Der Pfad für das Verzeichnis wird durch das Feld Export Folder Structure bestimmt.

Beim Wert "Nein" wird beim Export an Sharepoint geprüft, ob der Verzeichnis Pfad existiert.
Existiert das Verzeichnis, dann werden die verarbeiteten Dokumente hochgeladen (exportiert).
Existiert das Verzeichnis jedoch nicht, dann wird das Dokument nicht hochgeladen (nicht exportiert).
Es wird beim Export eine entsprechende Fehlermeldung ausgegeben. 
Dadurch soll vermieden werden, das unerwartete Verzeichnisse erstellt werden und Dokumente ggf. verschwinden.

Beispiel

_{Abbildung - Beispiel ausgefülltes Formular für Export Interface (WIP)}

Wenn wir eine neue Applikation in Microsoft Azure erstellt haben, rufen wir diese auf und erhalten folgende Ansicht.

_{Abbildung - Registrierte Microsoft Applikation "Neue SharePoint Applikation"}

Auf dieser Abbildung ist zu sehen was die Client ID ist, sowie wo die Tenant ID zu finden ist.
Bei Auswahl des Menüs "Certificates & secrets" existiert ein kleiner Button mit dem Namen "New client secrets". Nachdem die nötigen Daten angegeben wurden erhalten wir einen neuen Eintrag:

Feldwerte / Metadaten exportieren

Um Feldwerte als Metadaten zu exportieren, beim Upload, müssen diese in der Dokumentenklasse angegeben werden.
Dafür muss das nötige Feld ausgewählt werden, und der entsprechende Wert muss im Feld "Name (Zielsystem)" eingetragen werden.

_{Abbildung - Kopfdaten-Felder der Dokumentenklasse}