API des Actions

Exécutez et gérez les actions de workflow de manière programmatique.

Vue d'ensemble

L'API des Actions fournit des points de terminaison pour gérer et exécuter des actions de workflow au sein de mindzieStudio. Les actions sont des composants de workflow automatisés pouvant être exécutés à la demande ou selon un calendrier.

Structure de l'URL de base

Tous les points de terminaison de l'API des Actions suivent ce schéma :

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

Paramètres de chemin :

Paramètre Type Description
tenantId GUID Votre identifiant de locataire
projectId GUID Votre identifiant de projet

Points de terminaison disponibles

Surveillance de santé

Testez la connectivité et validez l'authentification.

  • GET /api/{tenantId}/{projectId}/action/unauthorized-ping - Test de connectivité basique (authentification non requise)
  • GET /api/{tenantId}/{projectId}/action/ping - Test de connectivité authentifié

Voir la documentation Ping

Gestion des actions

Listez et récupérez les détails des actions.

  • GET /api/{tenantId}/{projectId}/action - Liste toutes les actions pour un projet
  • GET /api/{tenantId}/{projectId}/action/{actionId} - Obtient les détails d’une action spécifique

Voir la documentation Gestion des actions

Exécution des actions

Déclenchez l’exécution d’actions de façon programmatique.

  • GET /api/{tenantId}/{projectId}/action/execute/{actionId} - Exécute une action

Voir la documentation Exécution

Authentification

La plupart des points de terminaison requièrent une authentification par token Bearer ou clé API. La seule exception est le point de terminaison unauthorized-ping qui peut être appelé sans authentification.

Exemple de requête authentifiée :

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

Cas d’utilisation courants

  • Surveillance de santé : Utilisez les points de terminaison ping pour vérifier la connectivité et l’authentification de l’API
  • Automatisation : Exécutez les actions de manière programmatique dans le cadre de pipelines ETL ou de tâches planifiées
  • Intégration : Déclenchez des workflows mindzieStudio depuis des systèmes externes
  • Supervision : Listez et inspectez les actions pour suivre l’état des workflows

Réponses d’erreur

Tous les points de terminaison renvoient des codes HTTP standard :

Statut Description
200 Succès
401 Non autorisé - authentification invalide ou manquante
404 Non trouvé - l’action ou la ressource n’existe pas

Commencer

  1. Commencez par les points de terminaison Ping pour tester la connectivité
  2. Utilisez la Gestion des actions pour découvrir les actions disponibles
  3. Exécutez les actions pour déclencher les workflows