Actions API

Führen Sie Workflow-Aktionen programmatisch aus und verwalten Sie sie.

Übersicht

Die Actions API bietet Endpunkte zum Verwalten und Ausführen von Workflow-Aktionen innerhalb von mindzieStudio. Aktionen sind automatisierte Workflow-Komponenten, die auf Abruf oder nach Zeitplan ausgeführt werden können.

Basis-URL-Struktur

Alle Action-API-Endpunkte folgen diesem Muster:

/api/{tenantId}/{projectId}/action/...

Pfadparameter:

Parameter Typ Beschreibung
tenantId GUID Ihre Mandantenkennung
projectId GUID Ihre Projektkennung

Verfügbare Endpunkte

Gesundheitsüberwachung

Testen Sie die Konnektivität und validieren Sie die Authentifizierung.

  • GET /api/{tenantId}/{projectId}/action/unauthorized-ping - Basis-Konnektivitätstest (keine Authentifizierung erforderlich)
  • GET /api/{tenantId}/{projectId}/action/ping - Authentifizierter Konnektivitätstest

Ping-Dokumentation ansehen

Aktionsverwaltung

Listen Sie Aktionen auf und rufen Sie Aktionsdetails ab.

  • GET /api/{tenantId}/{projectId}/action - Alle Aktionen für ein Projekt auflisten
  • GET /api/{tenantId}/{projectId}/action/{actionId} - Details zu einer bestimmten Aktion abrufen

Dokumentation zur Aktionsverwaltung ansehen

Aktionen ausführen

Lösen Sie die Ausführung von Aktionen programmatisch aus.

  • GET /api/{tenantId}/{projectId}/action/execute/{actionId} - Eine Aktion ausführen

Dokumentation zur Ausführung ansehen

Authentifizierung

Die meisten Endpunkte erfordern eine Authentifizierung über einen Bearer-Token oder API-Schlüssel. Die einzige Ausnahme ist der Endpunkt unauthorized-ping, der ohne Authentifizierung aufgerufen werden kann.

Beispiel für eine authentifizierte Anfrage:

GET https://your-mindzie-instance.com/api/{tenantId}/{projectId}/action/ping
Authorization: Bearer {your-access-token}

Gängige Anwendungsfälle

  • Gesundheitsüberwachung: Nutzen Sie Ping-Endpunkte, um API-Konnektivität und Authentifizierung zu überprüfen
  • Automatisierung: Führen Sie Aktionen programmatisch als Teil von ETL-Pipelines oder geplanten Jobs aus
  • Integration: Starten Sie mindzieStudio-Workflows aus externen Systemen
  • Überwachung: Listen und überprüfen Sie Aktionen, um den Workflow-Status zu verfolgen

Fehlerantworten

Alle Endpunkte liefern Standard-HTTP-Statuscodes zurück:

Status Beschreibung
200 Erfolg
401 Nicht autorisiert – ungültige oder fehlende Authentifizierung
404 Nicht gefunden – Aktion oder Ressource existiert nicht

Erste Schritte

  1. Beginnen Sie mit den Ping-Endpunkten zum Testen der Konnektivität
  2. Verwenden Sie die Aktionsverwaltung, um verfügbare Aktionen zu entdecken
  3. Aktionen ausführen, um Workflows auszulösen