Référence complète de l'API pour gérer les projets dans Blue - créer, mettre à jour, supprimer et interroger des projets
Vue d'ensemble
Les projets sont l'unité organisationnelle centrale dans Blue. Ils contiennent des listes, des tâches, des champs personnalisés, des automatisations et toutes les autres données liées au travail. Les projets appartiennent à des entreprises et ont leurs propres systèmes de permissions, modèles et configurations.
Opérations Disponibles
Opérations de Projet de Base
Opération | Description | Lien |
---|---|---|
Create Project | Créer un nouveau projet ou à partir d'un modèle | View Details → |
List Projects | Interroger et filtrer les projets | View Details → |
Delete Project | Supprimer définitivement un projet | View Details → |
Archive Project | Archiver/désarchiver des projets | View Details → |
Rename Project | Mettre à jour le nom et le slug du projet | View Details → |
Copy Project | Dupliquer un projet existant | View Details → |
Composants du Projet
Composant | Description | Lien |
---|---|---|
Lists | Gérer les listes de tâches au sein des projets | View Details → |
Templates | Travailler avec des modèles de projet | View Details → |
Activity | Suivre l'activité et les changements du projet | View Details → |
Concepts Clés
Structure du Projet
- Les projets appartiennent à des entreprises
- Chaque projet peut avoir plusieurs listes
- Les listes contiennent des tâches
- Les projets supportent des champs personnalisés, des étiquettes et des automatisations
Modèle de Permissions
Les projets ont un système de permissions à plusieurs niveaux :
Niveau | Permissions |
---|---|
OWNER | Full control, can delete project |
ADMIN | Manage project settings, users, and content |
MEMBER | Create and edit content |
CLIENT | Limited edit access |
VIEW_ONLY | Read-only access |
COMMENT_ONLY | Can only comment |
Catégories de Projet
Les projets peuvent être catégorisés pour une meilleure organisation :
- CRM
- CROSS_FUNCTIONAL
- CUSTOMER_SUCCESS
- DESIGN
- ENGINEERING
- GENERAL (par défaut)
- HR
- IT
- MARKETING
- OPERATIONS
- PERSONAL
- PROCUREMENT
- PRODUCT
- SALES
Modèles Courants
Création d'un Projet de Base
mutation CreateProject {
createProject(input: {
name: "Q1 Marketing Campaign"
companyId: "company-123"
category: MARKETING
}) {
id
name
slug
}
}
Interrogation des Projets avec des Filtres
query GetProjects {
projectList(
filter: {
companyIds: ["company-123"]
isArchived: false
categories: [MARKETING, SALES]
}
sort: [{ field: updatedAt, direction: DESC }]
take: 20
) {
items {
id
name
category
todosCount
todosDoneCount
}
pageInfo {
hasNextPage
total
}
}
}
Remarque : La requête
projectList
est l'approche recommandée pour interroger des projets. Une requête héritéeprojects
existe mais ne doit pas être utilisée pour de nouvelles implémentations.
Gestion des Listes de Projet
# Get all lists in a project
query GetProjectLists {
todoLists(projectId: "project-123") {
id
title
position
todosCount
}
}
# Create a new list
mutation CreateList {
createTodoList(input: {
projectId: "project-123"
title: "To Do"
position: 1.0
}) {
id
title
}
}
Meilleures Pratiques
-
Nommage des Projets
- Utilisez des noms clairs et descriptifs
- Évitez les caractères spéciaux qui pourraient affecter les slugs
- Gardez les noms sous 50 caractères
-
Gestion des Permissions
- Commencez avec des permissions minimales
- Utilisez le rôle CLIENT pour les parties prenantes externes
- Auditez régulièrement l'accès aux projets
-
Organisation
- Utilisez des catégories pour regrouper des projets similaires
- Archivez les projets terminés au lieu de les supprimer
- Utilisez des modèles pour les types de projets répétitifs
-
Performance
- Utilisez la pagination pour de grandes listes de projets
- Filtrez par statut actif/archivé
- Limitez le nombre de listes par projet (max 50)
Gestion des Erreurs
Erreurs courantes que vous pourriez rencontrer :
Code d'Erreur | Description | Solution |
---|---|---|
PROJECT_NOT_FOUND |
Le projet n'existe pas ou aucun accès | Verify project ID and permissions |
COMPANY_NOT_FOUND |
L'entreprise n'existe pas | Check company ID |
FORBIDDEN |
Permissions insuffisantes | Ensure proper role level |
BAD_USER_INPUT |
Erreur de validation (par exemple, nom trop long) | Check input validation requirements |
Ressources Associées
- API des Enregistrements - Gestion des tâches/enregistrements au sein des projets
- API des Champs Personnalisés - Ajout de champs personnalisés aux projets
- API des Automatisations - Configuration des automatisations de projet
- API des Utilisateurs - Gestion des utilisateurs et des permissions de projet