Berichte zur API

Aus Planfix

Planfix bietet zwei Möglichkeiten, Berichts‑Daten über die REST‑API abzurufen:

  • Sie können einen geplanten Bericht erstellen und dessen Daten über die REST API abrufen.
  • Oder Sie lösen die Berichterstellung über die REST API aus und rufen die Daten ab, 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 Kontoverwaltung — Zugriff auf API — REST API — Neues Token erstellen:
    • Im Feld Employee / Contact geben Sie den Mitarbeiter an, der den geplanten Bericht erhalten soll.
    • Im Feld Allowed Scopes tragen 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 gewünschten Berichts in der Antwort (die Berichts‑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.
  • Ist der Bericht sehr groß, kann die Version in mehrere Teile (Chunks) aufgeteilt sein. Beim Abrufen der Berichtsdaten müssen Sie den Chunk‑Index übergeben, um alle Teile zu erhalten. Mit der Methode /report/[id]/save/list können Sie die Anzahl der Chunks im Bericht ermitteln.

Erzeugen von Berichten über die REST‑API

  • 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 Kontoverwaltung — Zugriff auf API — REST API — Neues Token erstellen:
    • Im Feld Employee / Contact geben Sie den Mitarbeiter an, der den geplanten Bericht erhalten soll.
    • Im Feld Allowed Scopes tragen Sie ein: report_readonly.
  • Lösen Sie die Berichtserstellung über den Endpunkt /report/{id}/generate aus. Die Antwort enthält ein requestId.
  • Prüfen Sie nach kurzer Zeit den Status des Berichts über /report/status/{requestId}.

Enthält die Antwort ein ReportSave‑Objekt (im gleichen Format wie bei geplanten Berichten), ist der Bericht fertig.

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

Einschränkungen bei der Generierung

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

Gehe zu