Uppdatera titeln på en befintlig instrumentpanel med hjälp av Blue API
Byt namn på en instrumentpanel
Mutation editDashboard
gör att du kan byta namn på en instrumentpanel genom att uppdatera dess titel. Endast skaparen av instrumentpanelen har behörighet att byta namn på den.
Grundläggande exempel
mutation RenameDashboard {
editDashboard(
input: {
id: "dash_abc123"
title: "Q4 Sales Dashboard"
}
) {
id
title
updatedAt
}
}
Avancerat exempel med användarhantering
Mutation editDashboard
kan också uppdatera användarna på instrumentpanelen samtidigt som den byter namn:
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
}
}
Indata parametrar
EditDashboardInput
Parameter | Typ | Obligatorisk | Beskrivning |
---|---|---|---|
id |
String! | ✅ Ja | Det unika identifieraren för instrumentpanelen som ska bytas namn |
title |
String | Nej | Den nya titeln för instrumentpanelen. Om den inte anges förblir titeln oförändrad |
dashboardUsers |
[EditDashboardUserInput!] | Nej | Valfri array för att uppdatera användarbehörigheter på instrumentpanelen |
EditDashboardUserInput
Parameter | Typ | Obligatorisk | Beskrivning |
---|---|---|---|
userId |
String! | ✅ Ja | ID:t för användaren som ska läggas till eller uppdateras |
role |
DashboardRole! | ✅ Ja | Rollen som ska tilldelas användaren |
DashboardRole Värden
Värde | Beskrivning |
---|---|
EDITOR |
Kan visa och redigera innehållet på instrumentpanelen (diagram, filter, layout) |
VIEWER |
Kan endast visa instrumentpanelen |
Svarsfält
Mutation returnerar ett komplett Dashboard
objekt:
Fält | Typ | Beskrivning |
---|---|---|
id |
String! | Unik identifierare för instrumentpanelen |
title |
String! | Den uppdaterade titeln på instrumentpanelen |
createdBy |
User! | Den användare som skapade instrumentpanelen |
dashboardUsers |
[DashboardUser!]! | Lista över användare med åtkomst till instrumentpanelen |
createdAt |
DateTime! | När instrumentpanelen skapades |
updatedAt |
DateTime! | När instrumentpanelen senast modifierades |
Obligatoriska behörigheter
Endast skaparen av instrumentpanelen kan byta namn på en instrumentpanel. Andra användare med rollerna REDIGERARE eller VISARE kan inte ändra titeln på instrumentpanelen.
Användartyp | Kan byta namn på instrumentpanelen |
---|---|
Dashboard Creator | ✅ Ja |
Dashboard Editor | ❌ Nej |
Dashboard Viewer | ❌ Nej |
Other Company Users | ❌ Nej |
Felmeddelanden
Instrumentpanelen hittades inte
{
"errors": [{
"message": "Dashboard not found",
"extensions": {
"code": "NOT_FOUND"
}
}]
}
Otillräckliga behörigheter
{
"errors": [{
"message": "You don't have permission to edit this dashboard",
"extensions": {
"code": "FORBIDDEN"
}
}]
}
Valideringsfel
{
"errors": [{
"message": "Dashboard title cannot be empty",
"extensions": {
"code": "VALIDATION_ERROR"
}
}]
}
Viktiga anteckningar
- Ingen separat namnbyten mutation: Det finns ingen
renameDashboard
mutation. Namnbyte hanteras genomeditDashboard
mutation - Endast skaparbehörighet: Endast skaparen av instrumentpanelen kan byta namn på den, även om andra användare har REDIGERARE-roll
- Titelvalidering: Titlar på instrumentpaneler måste vara icke-tomma strängar
- Atomär operation: När både titel och användare uppdateras, antingen lyckas alla ändringar eller så tillämpas inga
- Användarhantering: Du kan lägga till, uppdatera eller ta bort användare på instrumentpanelen i samma operation som namnbytet
Användningsfall
- Rebranding av instrumentpaneler: Uppdatera instrumentpanelernas namn för att återspegla ny företagsterminologi eller branding
- Säsongsuppdateringar: Byt namn på instrumentpaneler för att återspegla aktuella tidsperioder (t.ex. "Q3 2024 Försäljning" → "Q4 2024 Försäljning")
- Projektutveckling: Uppdatera titlar på instrumentpaneler när projekten ändrar omfattning eller fokus
- Förbättring av tydlighet: Byt namn på instrumentpaneler för att vara mer beskrivande eller följa namngivningskonventioner
Relaterade operationer
- Lista instrumentpaneler - Hämta alla instrumentpaneler för ett företag eller projekt
- Skapa instrumentpanel - Skapa en ny instrumentpanel
- Ta bort instrumentpanel - Ta bort en instrumentpanel
- Kopiera instrumentpanel - Duplicera en befintlig instrumentpanel