Zum Hauptinhalt springen

Diagramme und Prozesssteckbriefe über die API herunterladen

Rufen Sie ein Webdiagramm als Bild ab oder erstellen Sie ein Prozesssteckbrief-Dokument über die REST-API. Beides läuft als asynchroner Job: Sie starten den Job, fragen seinen Status ab und laden die Ausgabe herunter, wenn er abgeschlossen ist. Der Ablauf ist für beides gleich – nur die Endpunkte zum Starten und Herunterladen unterscheiden sich.

Hinweis

Diese Endpunkte sind nur in iGrafx Cloud verfügbar. On-Premises-Bereitstellungen stellen sie nicht bereit – ein Aufruf schlägt fehl, auch wenn Sie ihn senden.

Voraussetzungen​

  • Eine funktionierende REST-API-Integration – siehe Auf die REST-API zugreifen.
  • Die Berechtigung, das Zieldiagramm oder -objekt anzuzeigen, in einem Repository, das Sie verwenden können.

Schritte​

  1. Starten Sie den Job. Rufen Sie den Start-Endpunkt für das auf, was Sie erzeugen möchten. Er gibt einen Job zurück, mit dessen ID Sie das Ergebnis verfolgen und herunterladen.

    ErgebnisAufruf
    Ein DiagrammbildStart a backend diagram render job – POST /api/repositories/{repository}/webdiagrams/{webDiagramId}/render
    Ein Prozesssteckbrief-DokumentStart a narrative download job – POST /api/repositories/{repository}/objects/{objectId}/narrative

    Übergeben Sie für einen Prozesssteckbrief das format (DOCX oder PDF). Lassen Sie die Prozesssteckbrief-Vorlage weg, um den Standard-Prozesssteckbrief des Repositorys für den Typ des Objekts zu verwenden. Für ein Diagramm legt ein optionaler Anfragetext Bildoptionen wie das Dateiformat fest.

  2. Fragen Sie den Job-Status ab. Rufen Sie Get job information for a specific job – GET /api/jobs/{jobId} – auf, bis der Job als abgeschlossen gemeldet wird. Verwenden Sie eine Verzögerung, die zwischen den Versuchen wächst; siehe Eine robuste API-Integration aufbauen.

  3. Laden Sie die Ausgabe herunter. Sobald der Job abgeschlossen ist, rufen Sie den passenden Download-Endpunkt auf:

    DownloadAufruf
    Das DiagrammbildDownload a rendered diagram image – GET /api/repositories/{repository}/webdiagrams/{webDiagramId}/render/{jobId}/output
    Das Prozesssteckbrief-DokumentDownload a narrative document – GET /api/repositories/{repository}/objects/{objectId}/narrative/{jobId}/output

    Ein Download, der aufgerufen wird, bevor der Job abgeschlossen ist, gibt 409 Conflict zurück.

Referenz​

Anfragetexte, Parameter und Antwortschemas finden Sie bei diesen Endpunkten im Portal iGrafx REST API unter BPMNBPMN Eine grafische Standardnotation von ISO/OMG zur Modellierung von Geschäftsprozessen. Process360 Live verwendet BPMN 2.0 für Design- und Simulationsartefakte. Diagrams, Object Narrative und Jobs.