Zaktualizuj tytuł istniejącego pulpitu za pomocą API Blue
Zmień nazwę pulpitu
Mutacja editDashboard
pozwala na zmianę nazwy pulpitu poprzez aktualizację jego tytułu. Tylko twórca pulpitu ma uprawnienia do zmiany jego nazwy.
Podstawowy przykład
mutation RenameDashboard {
editDashboard(
input: {
id: "dash_abc123"
title: "Q4 Sales Dashboard"
}
) {
id
title
updatedAt
}
}
Zaawansowany przykład z zarządzaniem użytkownikami
Mutacja editDashboard
może również aktualizować użytkowników pulpitu podczas zmiany nazwy:
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
}
}
Parametry wejściowe
EditDashboardInput
Parametr | Typ | Wymagane | Opis |
---|---|---|---|
id |
String! | ✅ Tak | Unikalny identyfikator pulpitu do zmiany nazwy |
title |
String | Nie | Nowy tytuł pulpitu. Jeśli nie podano, tytuł pozostaje bez zmian |
dashboardUsers |
[EditDashboardUserInput!] | Nie | Opcjonalna tablica do aktualizacji uprawnień użytkowników pulpitu |
EditDashboardUserInput
Parametr | Typ | Wymagane | Opis |
---|---|---|---|
userId |
String! | ✅ Tak | ID użytkownika do dodania lub aktualizacji |
role |
DashboardRole! | ✅ Tak | Rola do przypisania użytkownikowi |
Wartości DashboardRole
Wartość | Opis |
---|---|
EDITOR |
Może przeglądać i edytować zawartość pulpitu (wykresy, filtry, układ) |
VIEWER |
Może tylko przeglądać pulpit |
Pola odpowiedzi
Mutacja zwraca kompletny obiekt Dashboard
:
Pole | Typ | Opis |
---|---|---|
id |
String! | Unikalny identyfikator pulpitu |
title |
String! | Zaktualizowany tytuł pulpitu |
createdBy |
User! | Użytkownik, który utworzył pulpit |
dashboardUsers |
[DashboardUser!]! | Lista użytkowników z dostępem do pulpitu |
createdAt |
DateTime! | Kiedy pulpit został utworzony |
updatedAt |
DateTime! | Kiedy pulpit był ostatnio modyfikowany |
Wymagane uprawnienia
Tylko twórca pulpitu może zmienić nazwę pulpitu. Inni użytkownicy z rolami EDITOR lub VIEWER nie mogą zmieniać tytułu pulpitu.
Typ użytkownika | Może zmienić nazwę pulpitu |
---|---|
Dashboard Creator | ✅ Tak |
Dashboard Editor | ❌ Nie |
Dashboard Viewer | ❌ Nie |
Other Company Users | ❌ Nie |
Odpowiedzi błędów
Pulpit nie znaleziony
{
"errors": [{
"message": "Dashboard not found",
"extensions": {
"code": "NOT_FOUND"
}
}]
}
Niewystarczające uprawnienia
{
"errors": [{
"message": "You don't have permission to edit this dashboard",
"extensions": {
"code": "FORBIDDEN"
}
}]
}
Błąd walidacji
{
"errors": [{
"message": "Dashboard title cannot be empty",
"extensions": {
"code": "VALIDATION_ERROR"
}
}]
}
Ważne uwagi
- Brak osobnej mutacji zmiany nazwy: Nie ma mutacji
renameDashboard
do zmiany nazwy. Zmiana nazwy jest obsługiwana przez mutacjęeditDashboard
- Uprawnienia tylko dla twórcy: Tylko twórca pulpitu może go zmienić, nawet jeśli inni użytkownicy mają rolę EDITOR
- Walidacja tytułu: Tytuły pulpitów muszą być niepustymi ciągami
- Operacja atomowa: Podczas aktualizacji zarówno tytułu, jak i użytkowników, albo wszystkie zmiany się powiodą, albo żadna nie zostanie zastosowana
- Zarządzanie użytkownikami: Możesz dodać, zaktualizować lub usunąć użytkowników pulpitu w tej samej operacji co zmiana nazwy
Przykłady użycia
- Rebranding pulpitów: Zaktualizuj nazwy pulpitów, aby odzwierciedlały nową terminologię lub branding firmy
- Aktualizacje sezonowe: Zmień nazwy pulpitów, aby odzwierciedlały aktualne okresy czasu (np. "Sprzedaż Q3 2024" → "Sprzedaż Q4 2024")
- Ewolucja projektu: Zaktualizuj tytuły pulpitów, gdy projekty zmieniają zakres lub fokus
- Poprawa klarowności: Zmień nazwy pulpitów, aby były bardziej opisowe lub zgodne z konwencjami nazewnictwa
Powiązane operacje
- Lista pulpitów - Pobierz wszystkie pulpity dla firmy lub projektu
- Utwórz pulpit - Utwórz nowy pulpit
- Usuń pulpit - Usuń pulpit
- Skopiuj pulpit - Duplikuj istniejący pulpit