Dynamische Parameter (Fallbeispiel)

Im oberen Bereich der Parameterkonfiguration wird eine Vorschau der auszuführenden Abfrage-URL angezeigt. Der Parameter id wurde im URI-Pattern ersetzt, da die Option URL Parameter gesetzt ist. Wird die Option nicht gesetzt, wird stattdessen ein Query-Parameter an die Abfrage-URL angehangen.

Aufbau der Abfrage-URL:
{BaseUri}/{Version}/{Uri Pattern} -> {BaseUri}/{Version}/{Resource}/{id}
-> https://graph.microsoft.com/v1.0/users/ID_WERT

Nachfolgend kann der Parameter auf der Seite Table Configuration ausgewählt und eine Abfrage damit gestartet werden.

In diesem Beispiel kommen einige Werte zurück, die in der allgemeinen Anfrage nicht vorhanden waren. Werte die bereits in der ersten Ressource eingesammelt wurden, können hier deaktiviert bleiben.

Dynamische Parameter

Um die Detailinformationen zur Ressource users für alle gesammelten Datensätze automatisiert abrufen zu können, ist es möglich dynamische Parameter zu definieren. In diesem Beispiel soll mit jeder id aus der ersten Ressource, eine Abfrage mit der zweiten Ressource durchgeführt werden. Konkret bedeutet das, dass die Ressource users/{id} für jede vorhandene ID einmal abgefragt werden soll.

Ressourcen-Parameter

Mit dem Parametertyp Resource ist es möglich die Werte einer Tabelle, einer anderen Ressource, als Parameter zu wählen. Dabei muss diese Referenz-Ressource vorher eingesammelt worden sein. Das kann durch die Sortierreihenfolge (Spalte Sorting) sichergestellt werden.

Nach Speichern des Parameters, wird unter Value die entsprechende SQL-Abfrage angezeigt. Der statische Hilfs-Parameter kann deaktiviert werden, da er bei der automatisierten Datensammlung nicht berücksichtig werden soll.

Alternativ kann auch eine benutzerdefinierte SQL-Abfrage hinterlegt werden. Diese darf nur eine Spalte zurückgeben.

Bei einem dynamischen Parameter wird für jedes SQL-Abfrageergebnis eine API-Abfrage durchgeführt.
Jedes SQL-Abfrageergebnis zählt als eigener Parameter. 

 

 

 

Fallbeispiel: https://abfallnavi.api.bund.dev/

Konfiguration der Ressourcen:

Uri Pattern: Hiermit kann die Abfrage-Adresse für die jeweilige Ressource angepasst werden. Dieser Wert bezieht sich nur auf die Ressource und es ist möglich, beliebige Keys aus den konfigurierten Query-Parametern anzugeben. Diese werden dann automatisch, beim Einsammeln der Daten, mit den jeweiligen dynamischen oder statischen Parameterwerten ersetzt. Der Wert {Value} oder {Resource} entspricht hier immer der Spalte Value / Resource.

Im folgenden Beispiel wird ein Teil der URL {strassenId} im Uri Pattern dynamisch durch die ID ersetzt, die in der vorhergehenden Ressource "Straßen, Solingen" eingesammelt wurde. Damit kann die Ressource "Termine" für alle vorher ermittelten Straßen eingesammelt werden. Mit dem Parametertyp "Resource" kann dazu die passende Tabelle und Spalte ausgewählt werden, dessen Werte als Parameter genutzt werden sollen. 

Alternativ besteht auch die Möglichkeit ein SQL-Query zu hinterlegen (Parametertyp Query), welches genau eine Spalte zurückgeben darf.