Mettre à jour le titre d'un tableau de bord existant en utilisant l'API Blue


Renommer un tableau de bord

La mutation editDashboard vous permet de renommer un tableau de bord en mettant à jour son titre. Seul le créateur du tableau de bord a la permission de renommer un tableau de bord.

Exemple de base

mutation RenameDashboard {
  editDashboard(
    input: {
      id: "dash_abc123"
      title: "Q4 Sales Dashboard"
    }
  ) {
    id
    title
    updatedAt
  }
}

Exemple avancé avec gestion des utilisateurs

La mutation editDashboard peut également mettre à jour les utilisateurs du tableau de bord tout en le renommant :

mutation RenameAndUpdateUsers {
  editDashboard(
    input: {
      id: "dash_abc123"
      title: "Updated Sales Dashboard"
      dashboardUsers: [
        {
          userId: "user_123"
          role: EDITOR
        }
        {
          userId: "user_456"
          role: VIEWER
        }
      ]
    }
  ) {
    id
    title
    dashboardUsers {
      id
      user {
        id
        email
        firstName
        lastName
      }
      role
    }
    updatedAt
  }
}

Paramètres d'entrée

EditDashboardInput

Paramètre Type Requis Description
id String! ✅ Oui L'identifiant unique du tableau de bord à renommer
title String Non Le nouveau titre pour le tableau de bord. S'il n'est pas fourni, le titre reste inchangé
dashboardUsers [EditDashboardUserInput!] Non Tableau optionnel pour mettre à jour les permissions des utilisateurs du tableau de bord

EditDashboardUserInput

Paramètre Type Requis Description
userId String! ✅ Oui L'ID de l'utilisateur à ajouter ou à mettre à jour
role DashboardRole! ✅ Oui Le rôle à attribuer à l'utilisateur

Valeurs de DashboardRole

Valeur Description
EDITOR Peut voir et éditer le contenu du tableau de bord (graphiques, filtres, mise en page)
VIEWER Peut uniquement voir le tableau de bord

Champs de réponse

La mutation renvoie un objet complet Dashboard :

Champ Type Description
id String! Identifiant unique du tableau de bord
title String! Le titre mis à jour du tableau de bord
createdBy User! L'utilisateur qui a créé le tableau de bord
dashboardUsers [DashboardUser!]! Liste des utilisateurs ayant accès au tableau de bord
createdAt DateTime! Date de création du tableau de bord
updatedAt DateTime! Date de dernière modification du tableau de bord

Permissions requises

Seul le créateur du tableau de bord peut renommer un tableau de bord. D'autres utilisateurs ayant des rôles d'ÉDITEUR ou de CONSULTATION ne peuvent pas changer le titre du tableau de bord.

Type d'utilisateur Peut renommer le tableau de bord
Dashboard Creator ✅ Oui
Dashboard Editor ❌ Non
Dashboard Viewer ❌ Non
Other Company Users ❌ Non

Réponses d'erreur

Tableau de bord non trouvé

{
  "errors": [{
    "message": "Dashboard not found",
    "extensions": {
      "code": "NOT_FOUND"
    }
  }]
}

Permissions insuffisantes

{
  "errors": [{
    "message": "You don't have permission to edit this dashboard",
    "extensions": {
      "code": "FORBIDDEN"
    }
  }]
}

Erreur de validation

{
  "errors": [{
    "message": "Dashboard title cannot be empty",
    "extensions": {
      "code": "VALIDATION_ERROR"
    }
  }]
}

Remarques importantes

  • Pas de mutation de renommage séparée : Il n'y a pas de mutation renameDashboard. Le renommage est géré via la mutation editDashboard
  • Permission réservée au créateur : Seul le créateur du tableau de bord peut le renommer, même si d'autres utilisateurs ont le rôle d'ÉDITEUR
  • Validation du titre : Les titres des tableaux de bord doivent être des chaînes non vides
  • Opération atomique : Lors de la mise à jour à la fois du titre et des utilisateurs, soit tous les changements réussissent, soit aucun n'est appliqué
  • Gestion des utilisateurs : Vous pouvez ajouter, mettre à jour ou supprimer des utilisateurs du tableau de bord dans la même opération que le renommage

Cas d'utilisation

  1. Rebranding des tableaux de bord : Mettre à jour les noms des tableaux de bord pour refléter la nouvelle terminologie ou le nouveau branding de l'entreprise
  2. Mises à jour saisonnières : Renommer les tableaux de bord pour refléter les périodes de temps actuelles (par exemple, "Ventes T3 2024" → "Ventes T4 2024")
  3. Évolution du projet : Mettre à jour les titres des tableaux de bord à mesure que les projets changent de portée ou de focus
  4. Améliorations de clarté : Renommer les tableaux de bord pour qu'ils soient plus descriptifs ou pour suivre des conventions de nommage

Opérations connexes

Assistant IA

Les réponses sont générées par l'IA et peuvent contenir des erreurs.

Comment puis-je vous aider ?

Posez-moi toutes vos questions sur Blue ou cette documentation.

Entrez pour envoyer • Maj+Entrée pour une nouvelle ligne • ⌘I pour ouvrir