Actions API
Voer workflow-acties uit en beheer ze programmatically.
Overzicht
De Actions API biedt endpoints voor het beheren en uitvoeren van workflow-acties binnen mindzieStudio. Acties zijn geautomatiseerde workflowcomponenten die op aanvraag of op schema kunnen worden uitgevoerd.
Basis URL-structuur
Alle Action API-endpoints volgen dit patroon:
/api/{tenantId}/{projectId}/action/...
Padparameters:
| Parameter | Type | Beschrijving |
|---|---|---|
tenantId |
GUID | Uw tenant-id |
projectId |
GUID | Uw project-id |
Beschikbare Endpoints
Gezondheidscontrole
Test connectiviteit en verifieer authenticatie.
- GET
/api/{tenantId}/{projectId}/action/unauthorized-ping- Basis connectiviteitstest (geen authenticatie vereist) - GET
/api/{tenantId}/{projectId}/action/ping- Geauthenticeerde connectiviteitstest
Actiebeheer
Lijst en haal actiegegevens op.
- GET
/api/{tenantId}/{projectId}/action- Lijst alle acties voor een project - GET
/api/{tenantId}/{projectId}/action/{actionId}- Ophalen van specifieke actiegegevens
Bekijk Actiebeheer Documentatie
Acties Uitvoeren
Start actie-uitvoering programmatically.
- GET
/api/{tenantId}/{projectId}/action/execute/{actionId}- Voer een actie uit
Bekijk Uitvoeringsdocumentatie
Authenticatie
De meeste endpoints vereisen authenticatie via Bearer-token of API-sleutel. De enige uitzondering is het unauthorized-ping endpoint dat zonder authenticatie kan worden aangeroepen.
Voorbeeld van een geauthenticeerd verzoek:
GET https://your-mindzie-instance.com/api/{tenantId}/{projectId}/action/ping
Authorization: Bearer {your-access-token}
Veelvoorkomende Gebruikssituaties
- Gezondheidscontrole: Gebruik ping-endpoints om API-connectiviteit en authenticatie te verifiëren
- Automatisering: Voer acties programmatically uit als onderdeel van ETL-pijplijnen of geplande taken
- Integratie: Start mindzieStudio-workflows vanuit externe systemen
- Monitoring: Lijst en inspecteer acties om de workflow-status bij te houden
Foutmeldingen
Alle endpoints geven standaard HTTP-statuscodes terug:
| Status | Beschrijving |
|---|---|
| 200 | Succes |
| 401 | Niet geautoriseerd - ongeldige of ontbrekende authenticatie |
| 404 | Niet gevonden - actie of bron bestaat niet |
Aan de Slag
- Begin met Ping Endpoints om connectiviteit te testen
- Gebruik Actiebeheer om beschikbare acties te ontdekken
- Voer Acties Uit om workflows te starten