Öffentliche Use Case Manager-API-Workflows

Verwenden Sie diese Workflows, um Berichtsdaten in CSV- oder JSON-Dateien herunterzuladen. Für das JSON-Format können Sie ein paginiertes Format oder einen vollständigen Bericht generieren. Paginierte Dateien sind nützlich für Bereiche, in denen Sie JSON benötigen, wie z. B. die Benutzerschnittstelle, und Sie müssen durch die Ergebnisse paginieren. Sie können Seite für Seite anfordern und nicht die gesamte Ergebnismenge. Vollständige Berichtsdateien können schneller heruntergeladen werden als der JSON-Hauptteil, aber die Paginierung ist im Dateidownloadformat nicht verfügbar.

Wählen Sie einen Workflow aus, um Berichtsdaten herunterzuladen.

Workflow zum Generieren eines paginierten Ergebnisses in JSON

Generieren Sie den Use Case Explorer-Bericht als JSON-Array in einem Seitenformat. Dieser Workflow ist nützlich für Orte, an denen Sie JSON benötigen, z. B. die Benutzerschnittstelle, und Sie müssen einen Seitenumbruch durchführen. Sie können Seite für Seite anfordern und nicht die gesamte Ergebnismenge. Der Workflow ist ein dreistufiger Prozess, der die API-Endpunkte in der Reihenfolge verwendet, die in der folgenden Tabelle beschrieben ist:
Endpunkt Beschreibung
POST /api/use_case_explorer Generiert einen Bericht des Anwendungsfallexplorers und gibt eine reportId zurück. Diesen Endpunkt müssen Sie zuerst verwenden, wenn Sie eine Berichtsgenerierung starten. Füllen Sie den Hauptteil der Anforderung mit den Berichtsspalten und allen Filtern oder Tabellengruppierungen, die Sie im generierten Bericht wünschen. Verwenden Sie den zurückgegebenen reportId-Wert in anderen API-Aufrufen im Workflow.
GET /api/use_case_explorer/{reportId}/status Gibt den Status von /api/use_case_explorer zurück. Überprüfen Sie mithilfe des Endpunkts, ob die Berichtsgenerierung erfolgreich war oder fehlgeschlagen ist.
GET /api/use_case_explorer/{reportId}/result Gibt das Ergebnis von /api/use_case_explorer in einem paginierten JSON-Array zurück. Schließen Sie den reportId-Wert, der vom Endpunkt /api/use_case_explorer zurückgegeben wird, in den Pfad ein, um Ihr Ergebnis abzurufen.

Workflow zum Generieren und Herunterladen von Berichten in CSV

Erstellen Sie den vollständigen Bericht des Use Case Explorers im Format „ CSV “. Dieser Workflow ist ein 5-Schritt-Prozess, der die API-Endpunkte in der in der folgenden Tabelle beschriebenen Reihenfolge verwendet:

Endpunkt Beschreibung
POST /api/use_case_explorer Generiert einen Bericht des Anwendungsfallexplorers und gibt eine reportId zurück. Diesen Endpunkt müssen Sie zuerst verwenden, wenn Sie eine Berichtsgenerierung starten. Füllen Sie den Hauptteil der Anforderung mit den Berichtsspalten und allen Filtern oder Tabellengruppierungen, die Sie im generierten Bericht wünschen. Verwenden Sie den zurückgegebenen reportId-Wert in anderen API-Aufrufen im Workflow.
GET /api/use_case_explorer/{reportId}/status Gibt den Status von /api/use_case_explorer zurück. Überprüfen Sie mithilfe des Endpunkts, ob die Berichtsgenerierung abgeschlossen oder fehlgeschlagen ist.
POST /api/use_case_explorer/{reportId}/download_csv Startet den Download einer Berichtsdatei des Explorers für Anwendungsfälle im CSV-Format. Schließen Sie den reportId -Wert von /api/use_case_explorer result in den Pfad ein und füllen Sie den Hauptteil der Anforderung mit Ihren ausgewählten Spaltencodes, Sortierparametern, Regel-IDs oder Suchparametern, um eine jobIdzu erhalten.
GET /api/use_case_explorer/download_csv/{jobId}/status Überprüft den Status des Downloadjobs einer Berichtsdatei des Explorers für Anwendungsfälle im CSV-Format. Schließen Sie den jobId-Wert, der vom Endpunkt /api/use_case_explorer/{reportId}/download_csv zurückgegeben wird, in den Pfad ein, um einen Status darüber abzurufen, ob Ihr Job abgeschlossen oder fehlgeschlagen ist.
GET /api/use_case_explorer/download_csv/{jobId}/result Gibt den Bericht des Explorers für Anwendungsfälle in einer CSV-Datei zurück, wenn der Endpunkt /api/use_case_explorer/download_csv/{jobId}/status den Status 'Abgeschlossen' zurückgibt. Schließen Sie den jobId-Wert, der vom Endpunkt /api/use_case_explorer/{reportId}/download_csv zurückgegeben wird, und den gewünschten Namen für Ihre CSV-Datei in die Abfrage ein, um einen Download-Link für Ihre CSV-Datei abzurufen.

Workflow zum Generieren und Herunterladen von Berichten in JSON

Generieren Sie den Use Case Explorer-Bericht als JSON-Array in einem vollständigen Berichtsformat. Dieser Workflow ist nützlich, um die gesamte Ergebnismenge herunterzuladen, da die JSON-Datei schneller heruntergeladen werden kann als der JSON-Hauptteil. Die Paginierung ist im Dateidownloadformat nicht verfügbar. Der Workflow ist ein 5-Schritt-Prozess, der die API-Endpunkte in der in der folgenden Tabelle beschriebenen Reihenfolge verwendet:

Endpunkt Beschreibung
POST /api/use_case_explorer Generiert einen Bericht des Anwendungsfallexplorers und gibt eine reportId zurück. Diesen Endpunkt müssen Sie zuerst verwenden, wenn Sie eine Berichtsgenerierung starten. Füllen Sie den Hauptteil der Anforderung mit den Berichtsspalten und allen Filtern oder Tabellengruppierungen, die Sie im generierten Bericht wünschen. Verwenden Sie den zurückgegebenen reportId-Wert in anderen API-Endpunkten im Workflow.
GET /api/use_case_explorer/{reportId}/status Gibt den Status von /api/use_case_explorer zurück. Überprüfen Sie mithilfe des Endpunkts, ob die Berichtsgenerierung erfolgreich war oder fehlgeschlagen ist.
POST /api/use_case_explorer/{reportId}/download_json

Lädt den Bericht des Explorers für Anwendungsfälle als JSON-Datei herunter. Schließen Sie den reportId-Wert des Endpunkts /api/use_case_explorer in den Pfad ein und füllen Sie den Hauptteil mit Ihren ausgewählten Spaltencodes, Sortierparametern, Regel-IDs oder Suchparametern, um eine jobId abzurufen.
GET /api/use_case_explorer/download_json/{jobId}/status

Überprüft den Status des Downloadjobs einer Berichtsdatei des Explorers für Anwendungsfälle im JSON-Format. Schließen Sie den jobId-Wert, der vom Endpunkt /api/use_case_explorer/{reportId}/download_json zurückgegeben wird, in den Pfad ein, um einen Status darüber abzurufen, ob Ihr Job abgeschlossen oder fehlgeschlagen ist.
GET /api/use_case_explorer/download_json/{jobId}/result

Gibt das Endergebnis der JSON-Datei des Explorers für Anwendungsfälle zurück, nachdem der Endpunkt /api/use_case_explorer/download_json/{jobId}/status den Status 'Abgeschlossen' zurückgegeben hat. Schließen Sie den vom Endpunkt /api/use_case_explorer/{reportId}/download_json zurückgegebenen Wert jobId und den gewünschten Namen für Ihre JSON-Datei in die Abfrage ein, um einen Download-Link für Ihre JSON-Datei abzurufen.

Berichtsdaten herunterladen

Vorgehensweise

  1. Wählen Sie einen zu verwendenden Workflow aus.
  2. Klicken Sie auf Ausprobieren und füllen Sie dann die Anforderungsparameter für den ausgewählten Workflow aus. Weitere Informationen finden Sie unter Use Case Explorer filters und Report column codes for report APIs.

Nächste Schritte

Überprüfen Sie die Endpunktworkflows und versuchen Sie es mit dem Beispielscript oder verwenden Sie das Script als Basis für Ihre eigenen Scripts. Verwenden Sie die Filter und Berichtsspalten, die für Ihre Umgebung und Ihre Anforderungen sinnvoll sind.