Dashboard umbenennen

Aktualisieren Sie den Titel eines vorhandenen Dashboards über die Blue API

Dashboard umbenennen

Die editDashboard Mutation ermöglicht es Ihnen, ein Dashboard umzubenennen, indem Sie seinen Titel aktualisieren. Nur der Ersteller des Dashboards hat die Berechtigung, ein Dashboard umzubenennen.

Einfaches Beispiel

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

Fortgeschrittenes Beispiel mit Benutzerverwaltung

Die editDashboard Mutation kann auch die Benutzer des Dashboards beim Umbenennen aktualisieren:

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
  }
}

Eingabeparameter

EditDashboardInput

Parameter	Typ	Erforderlich	Beschreibung
`id`	String!	✅ Ja	Die eindeutige Kennung des Dashboards, das umbenannt werden soll
`title`	String	Nein	Der neue Titel für das Dashboard. Wenn nicht angegeben, bleibt der Titel unverändert
`dashboardUsers`	[EditDashboardUserInput!]	Nein	Optionales Array zur Aktualisierung der Benutzerberechtigungen für das Dashboard

EditDashboardUserInput

Parameter	Typ	Erforderlich	Beschreibung
`userId`	String!	✅ Ja	Die ID des Benutzers, der hinzugefügt oder aktualisiert werden soll
`role`	DashboardRole!	✅ Ja	Die Rolle, die dem Benutzer zugewiesen werden soll

DashboardRole Werte

Wert	Beschreibung
`EDITOR`	Kann den Inhalt des Dashboards (Diagramme, Filter, Layout) anzeigen und bearbeiten
`VIEWER`	Kann das Dashboard nur anzeigen

Antwortfelder

Die Mutation gibt ein vollständiges Dashboard Objekt zurück:

Feld	Typ	Beschreibung
`id`	String!	Eindeutige Dashboard-Kennung
`title`	String!	Der aktualisierte Dashboard-Titel
`createdBy`	User!	Der Benutzer, der das Dashboard erstellt hat
`dashboardUsers`	[DashboardUser!]!	Liste der Benutzer mit Zugriff auf das Dashboard
`createdAt`	DateTime!	Wann das Dashboard erstellt wurde
`updatedAt`	DateTime!	Wann das Dashboard zuletzt geändert wurde

Erforderliche Berechtigungen

Nur der Dashboard-Ersteller kann ein Dashboard umbenennen. Andere Benutzer mit den Rollen EDITOR oder VIEWER können den Dashboard-Titel nicht ändern.

Benutzertyp	Kann Dashboard umbenennen
Dashboard Creator	✅ Ja
Dashboard Editor	❌ Nein
Dashboard Viewer	❌ Nein
Other Company Users	❌ Nein

Fehlermeldungen

Dashboard nicht gefunden

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

Unzureichende Berechtigungen

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

Validierungsfehler

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

Wichtige Hinweise

Keine separate Umbenennungs-Mutation: Es gibt keine renameDashboard Mutation. Das Umbenennen erfolgt über die editDashboard Mutation.
Nur Ersteller-Berechtigung: Nur der Ersteller des Dashboards kann es umbenennen, selbst wenn andere Benutzer die EDITOR-Rolle haben.
Titelvalidierung: Dashboard-Titel müssen nicht-leere Zeichenfolgen sein.
Atomare Operation: Wenn sowohl Titel als auch Benutzer aktualisiert werden, müssen entweder alle Änderungen erfolgreich sein oder keine angewendet werden.
Benutzerverwaltung: Sie können Dashboard-Benutzer in derselben Operation wie das Umbenennen hinzufügen, aktualisieren oder entfernen.

Anwendungsfälle

Rebranding von Dashboards: Aktualisieren Sie die Dashboard-Namen, um neue Unternehmensbegriffe oder Marken zu reflektieren.
Saisonale Updates: Benennen Sie Dashboards um, um aktuelle Zeiträume widerzuspiegeln (z. B. "Q3 2024 Sales" → "Q4 2024 Sales").
Projektentwicklung: Aktualisieren Sie die Dashboard-Titel, wenn sich der Umfang oder der Fokus von Projekten ändert.
Klarheitsverbesserungen: Benennen Sie Dashboards um, um sie beschreibender zu gestalten oder Namenskonventionen zu folgen.