Werk de titel van een bestaand dashboard bij met de Blue API


Een Dashboard Hernoemen

De editDashboard mutatie stelt je in staat om een dashboard te hernoemen door de titel bij te werken. Alleen de maker van het dashboard heeft toestemming om een dashboard te hernoemen.

Basisvoorbeeld

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

Geavanceerd Voorbeeld met Gebruikersbeheer

De editDashboard mutatie kan ook dashboardgebruikers bijwerken tijdens het hernoemen:

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

Invoervariabelen

EditDashboardInput

Parameter Type Vereist Beschrijving
id String! ✅ Ja De unieke identificatie van het dashboard dat hernoemd moet worden
title String Nee De nieuwe titel voor het dashboard. Als deze niet wordt opgegeven, blijft de titel ongewijzigd
dashboardUsers [EditDashboardUserInput!] Nee Optionele array om de gebruikersrechten van het dashboard bij te werken

EditDashboardUserInput

Parameter Type Vereist Beschrijving
userId String! ✅ Ja De ID van de gebruiker die moet worden toegevoegd of bijgewerkt
role DashboardRole! ✅ Ja De rol die aan de gebruiker moet worden toegewezen

DashboardRole Waarden

Waarde Beschrijving
EDITOR Kan dashboardinhoud (grafieken, filters, lay-out) bekijken en bewerken
VIEWER Kan alleen het dashboard bekijken

Responsvelden

De mutatie retourneert een compleet Dashboard object:

Veld Type Beschrijving
id String! Unieke identificatie van het dashboard
title String! De bijgewerkte dashboardtitel
createdBy User! De gebruiker die het dashboard heeft gemaakt
dashboardUsers [DashboardUser!]! Lijst van gebruikers met toegang tot het dashboard
createdAt DateTime! Wanneer het dashboard is gemaakt
updatedAt DateTime! Wanneer het dashboard voor het laatst is gewijzigd

Vereiste Machtigingen

Alleen de maker van het dashboard kan een dashboard hernoemen. Andere gebruikers met de rollen EDITOR of VIEWER kunnen de dashboardtitel niet wijzigen.

Gebruikerstype Kan Dashboard Hernoemen
Dashboard Creator ✅ Ja
Dashboard Editor ❌ Nee
Dashboard Viewer ❌ Nee
Other Company Users ❌ Nee

Foutreacties

Dashboard Niet Gevonden

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

Onvoldoende Machtigingen

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

Validatiefout

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

Belangrijke Opmerkingen

  • Geen aparte hernoemmutatie: Er is geen renameDashboard mutatie. Hernoemen wordt afgehandeld via de editDashboard mutatie
  • Alleen maker-machtiging: Alleen de maker van het dashboard kan het hernoemen, zelfs als andere gebruikers de rol EDITOR hebben
  • Titelvalidatie: Dashboardtitels moeten niet-lege strings zijn
  • Atomische operatie: Bij het bijwerken van zowel titel als gebruikers, slagen alle wijzigingen of worden er geen toegepast
  • Gebruikersbeheer: Je kunt dashboardgebruikers toevoegen, bijwerken of verwijderen in dezelfde operatie als het hernoemen

Gebruikscases

  1. Hernamen van dashboards: Werk dashboardnamen bij om nieuwe bedrijfsterminologie of branding weer te geven
  2. Seizoensgebonden updates: Hernoem dashboards om actuele tijdsperioden weer te geven (bijv. "Q3 2024 Verkoop" → "Q4 2024 Verkoop")
  3. Projectontwikkeling: Werk dashboardtitels bij naarmate projecten van scope of focus veranderen
  4. Verbeteringen in duidelijkheid: Hernoem dashboards om beschrijvender te zijn of om naamgevingsconventies te volgen

Gerelateerde Operaties

AI Assistent

Antwoorden worden gegenereerd met behulp van AI en kunnen fouten bevatten.

Hoe kan ik u helpen?

Vraag me alles over Blue of deze documentatie.

Voer in om te verzenden • Shift+Enter voor nieuwe regel • ⌘I om te openen