API de Projet
Gérez les projets au sein des locataires mindzieStudio. Les projets sont les conteneurs de plus haut niveau pour les jeux de données, les investigations, les tableaux de bord et les flux de travail d'analyse.
Fonctionnalités
Gestion de Projet
Créer, récupérer, mettre à jour et supprimer des projets. Lister tous les projets d’un locataire avec prise en charge de la pagination.
Opérations sur le Cache
Charger les projets en mémoire pour un accès rapide lors des opérations API. Essentiel pour exécuter efficacement les notebooks et blocs.
Permissions Utilisateurs
Gérer l’accès des utilisateurs aux projets. Ajouter des utilisateurs, mettre à jour les niveaux de permission (propriétaire vs membre), et retirer l’accès.
Import & Export
Exporter les projets sous forme de fichiers .mpz portables pour sauvegarde ou transfert. Importer des projets à partir de fichiers .mpz. Gérer les miniatures de projet.
Points de Terminaison Disponibles
Test de Connectivité
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/unauthorized-ping |
Test de connectivité public |
| GET | /api/{tenantId}/project/ping |
Test de connectivité authentifié |
CRUD de Projet
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project |
Lister tous les projets |
| GET | /api/{tenantId}/project/{projectId} |
Obtenir les détails d’un projet |
| POST | /api/{tenantId}/project |
Créer un projet |
| PUT | /api/{tenantId}/project/{projectId} |
Mettre à jour un projet |
| DELETE | /api/{tenantId}/project/{projectId} |
Supprimer un projet |
| GET | /api/{tenantId}/project/{projectId}/summary |
Obtenir les statistiques d’un projet |
Gestion du Cache
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/load |
Charger un projet en cache |
| DELETE | /api/{tenantId}/project/{projectId}/unload |
Décharger un projet du cache |
Permissions Utilisateurs
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/users |
Lister les utilisateurs du projet |
| POST | /api/{tenantId}/project/{projectId}/users/{userId} |
Ajouter un utilisateur au projet |
| PUT | /api/{tenantId}/project/{projectId}/users/{userId} |
Mettre à jour la permission d’un utilisateur |
| DELETE | /api/{tenantId}/project/{projectId}/users/{userId} |
Retirer un utilisateur |
Import/Export
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/download |
Exporter en .mpz |
| POST | /api/{tenantId}/project/import |
Importer depuis .mpz |
Miniatures
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/thumbnail |
Obtenir la miniature |
| POST | /api/{tenantId}/project/{projectId}/thumbnail |
Mettre à jour la miniature |
| DELETE | /api/{tenantId}/project/{projectId}/thumbnail |
Supprimer la miniature |
Authentification
Tous les points de terminaison de l’API Projet requièrent une clé API valide. Utilisez des clés API limitées au locataire pour les opérations sur les projets.
Voir Authentification pour les détails sur les types et l’utilisation des clés API.
Démarrage Rapide
# Lister tous les projets d’un locataire
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project" \
-H "Authorization: Bearer YOUR_API_KEY"
# Charger un projet dans le cache avant d’exécuter les notebooks
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project/{projectId}/load" \
-H "Authorization: Bearer YOUR_API_KEY"
Notes Importantes
- Suppression en CASCADE : La suppression d’un projet supprime définitivement tous les jeux de données, investigations, tableaux de bord et fichiers
- Cache Obligatoire : Charger les projets en cache avant d’exécuter les notebooks ou blocs
- Durée du Cache : Les projets restent en cache pendant 30 minutes après le dernier accès
- Exporter Avant Suppression : Toujours exporter les projets avant suppression comme sauvegarde