HTTP-API des BI-Feeds

Grundlagen#

Die Endpunkte#

Spalten eines Objekts abfragen#

Der Schema-Endpunkt sagt, was von einem Objekt überhaupt ausgeliefert werden kann. Spalten mit Typen, die das Zielwerkzeug nicht kennt, werden ausgelassen statt geraten – sie stehen in unsupportedColumns. Das Feld recommendedOrderBy nennt eine brauchbare Sortierspalte für das Blättern.

curl -sS \
  -H "Authorization: Bearer $TOKEN" \
  "https://lakehouse.example.invalid/api/agent/tableau/schema\
?catalog=iceberg&schema=produkte&table=produkte" | jq .

Daten seitenweise holen#

# Erste Seite. Ab der zweiten ist orderBy Pflicht – deshalb gleich setzen.
curl -sS \
  -H "Authorization: Bearer $TOKEN" \
  "https://lakehouse.example.invalid/api/agent/tableau/rows\
?catalog=iceberg&schema=produkte&table=produkte\
&limit=1000&offset=0&orderBy=artikelnummer" | jq '.meta, .data[0]'

# Als CSV, etwa zum Weiterreichen an ein Skript
curl -sS \
  -H "Authorization: Bearer $TOKEN" \
  "https://lakehouse.example.invalid/api/agent/tableau/rows\
?catalog=iceberg&schema=produkte&table=produkte\
&limit=1000&orderBy=artikelnummer&format=csv" > produkte.csv

Parameter von /tableau/rows#

Ohne orderBy wird ab der zweiten Seite nicht etwa unsortiert geliefert, sondern gar nicht: 400 order_required. OFFSET ohne ORDER BY ist in einer parallelen Engine nicht stabil – eine Seite könnte Zeilen doppelt bringen und andere auslassen, ohne dass irgendwo ein Fehler auftritt.

Antwortform#

Die Datensätze liegen unter data – das ist der JSONPath, den auch Tableau liest. Daneben steht meta als Selbstauskunft der Seite; wer nur die Zeilen will, ignoriert es.

{
  "data": [
    { "artikelnummer": "A-1001", "bezeichnung": "Rohrschelle 20 mm", "lagerbestand": 412 }
  ],
  "meta": {
    "object": { "catalog": "iceberg", "schema": "produkte", "table": "produkte" },
    "columns": [
      { "name": "artikelnummer", "tableauType": "string" },
      { "name": "lagerbestand", "tableauType": "int" }
    ],
    "unsupportedColumns": [],
    "limit": 1000,
    "offset": 0,
    "rowCount": 1000,
    "hasMore": true,
    "order": ["artikelnummer"],
    "orderAll": false,
    "deterministicPaging": true
  }
}

Fehlercodes#

Wie Sie an ein Token kommen#

Der Feed stellt keine eigenen Token aus – er prüft die des Realms. Für einen einmaligen Abruf reicht ein Zugriffstoken aus der angemeldeten Sitzung. Für geplante Abrufe legt die Administration einen eigenen öffentlichen Client im Realm an und lässt das aufrufende Werkzeug den Authorization-Code-Fluss mit PKCE durchlaufen; der Client braucht einen Audience-Mapper auf agent. Die Adressen der Autorisierungs- und Token-Endpunkte nennt GET /tableau/info.