Berichte zur API

Aus Planfix
Wechseln zu: Navigation, Suche

Planfix bietet zwei Möglichkeiten, Berichtsdaten über die REST-API abzurufen:

  • Sie können einen geplanten Bericht erstellen und dessen Daten über die REST API abrufen.
  • Den Bericht über die REST API auslösen und die Daten abrufen, sobald sie bereitstehen.

Die vollständige REST-API-Spezifikation finden Sie hier.

Abrufen von Daten aus einem geplanten Bericht über die REST-API

  • Erstellen Sie einen wiederkehrenden Bericht.
  • Erstellen Sie ein Autorisierungstoken für den Mitarbeiter, an den Sie den Bericht senden möchten. Die gespeicherten Berichtsdaten sind nur für die Mitarbeiter verfügbar, die Sie als Empfänger ausgewählt haben. Um ein Token zu erstellen, gehen Sie zu Account Management — Access to API — REST API — Create a new token:
    • Im Feld Employee / Contact geben Sie den Mitarbeiter an, der den geplanten Bericht erhalten soll.
    • Im Feld Allowed Scopes geben Sie ein: report_readonly.
  • Rufen Sie die Liste der Berichte über die REST-API mit der Methode /report/list ab und finden Sie die ID des benötigten Berichts in der Antwort (die Bericht-ID finden Sie auch in der Adresszeile des Browsers).
  • Rufen Sie die Liste der gespeicherten Versionen des ausgewählten Berichts mit der Methode /report/{id}/save/list ab.
  • Rufen Sie die Berichtsdaten anhand der ID der neuen Version mit der Methode /report/{id}/save/{saveId}/data ab.

Hinweise zum Datenabruf

  • Gespeicherte Berichtsdaten sind nur für die Mitarbeiter verfügbar, die Sie als Empfänger ausgewählt haben.
  • Wenn der Bericht sehr groß ist, enthält die Version mehrere Teile (Chunks). Beim Abrufen der Berichtsdaten müssen Sie den Chunk-Index angeben, um alle Teile zu erhalten. Mit der Methode /report/[id]/save/list können Sie die Anzahl der Chunks im Bericht ermitteln.

Berichte per REST-API erzeugen

  • Erstellen Sie ein Autorisierungstoken für den Mitarbeiter, an den Sie den Bericht senden möchten. Die gespeicherten Berichtsdaten sind nur für die Mitarbeiter verfügbar, die Sie als Empfänger ausgewählt haben. Um ein Token zu erstellen, gehen Sie zu Account Management — Access to API — REST API — Create a new token:
    • Im Feld Employee / Contact geben Sie den Mitarbeiter an, der den Bericht erhalten soll.
    • Im Feld Allowed Scopes geben Sie ein: report_readonly.
  • Lösen Sie die Berichterzeugung mit dem Endpunkt /report/{id}/generate aus. Die Antwort enthält eine requestId.
  • Prüfen Sie nach kurzer Zeit den Status des Berichts mit /report/status/{requestId}.

Ist der Bericht fertig, enthält die Antwort ein ReportSave-Objekt (gleiches Format wie bei geplanten Berichten).

  • Rufen Sie die Berichtsdaten anhand der ID der gespeicherten Version mit der Methode /report/{id}/save/{saveId}/data ab.

Einschränkungen bei der Erzeugung

  • Nur im Corporate-Tarif verfügbar.
  • Berichte können höchstens alle 10 Minuten erzeugt werden.
  • Pro Account kann jeweils nur ein Bericht gleichzeitig erzeugt werden.
  • Berichte werden im Namen des Benutzers erzeugt, der mit dem API-Token verknüpft ist; es gelten dessen Zugriffsrechte.

Gehe zu