Perbarui judul dashboard yang ada menggunakan Blue API
Ganti Nama Dashboard
Mutasi editDashboard
memungkinkan Anda untuk mengganti nama dashboard dengan memperbarui judulnya. Hanya pencipta dashboard yang memiliki izin untuk mengganti nama dashboard.
Contoh Dasar
mutation RenameDashboard {
editDashboard(
input: {
id: "dash_abc123"
title: "Q4 Sales Dashboard"
}
) {
id
title
updatedAt
}
}
Contoh Lanjutan dengan Manajemen Pengguna
Mutasi editDashboard
juga dapat memperbarui pengguna dashboard saat mengganti nama:
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
}
}
Parameter Input
EditDashboardInput
Parameter | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
id |
String! | ✅ Ya | Pengidentifikasi unik dari dashboard yang akan diganti namanya |
title |
String | Tidak | Judul baru untuk dashboard. Jika tidak diberikan, judul tetap tidak berubah |
dashboardUsers |
[EditDashboardUserInput!] | Tidak | Array opsional untuk memperbarui izin pengguna dashboard |
EditDashboardUserInput
Parameter | Tipe | Diperlukan | Deskripsi |
---|---|---|---|
userId |
String! | ✅ Ya | ID pengguna yang akan ditambahkan atau diperbarui |
role |
DashboardRole! | ✅ Ya | Peran yang akan diberikan kepada pengguna |
Nilai DashboardRole
Nilai | Deskripsi |
---|---|
EDITOR |
Dapat melihat dan mengedit konten dashboard (grafik, filter, tata letak) |
VIEWER |
Hanya dapat melihat dashboard |
Bidang Respons
Mutasi mengembalikan objek Dashboard
yang lengkap:
Bidang | Tipe | Deskripsi |
---|---|---|
id |
String! | Pengidentifikasi unik dashboard |
title |
String! | Judul dashboard yang diperbarui |
createdBy |
User! | Pengguna yang membuat dashboard |
dashboardUsers |
[DashboardUser!]! | Daftar pengguna dengan akses ke dashboard |
createdAt |
DateTime! | Waktu saat dashboard dibuat |
updatedAt |
DateTime! | Waktu saat dashboard terakhir dimodifikasi |
Izin yang Diperlukan
Hanya pencipta dashboard yang dapat mengganti nama dashboard. Pengguna lain dengan peran EDITOR atau VIEWER tidak dapat mengubah judul dashboard.
Tipe Pengguna | Dapat Mengganti Nama Dashboard |
---|---|
Dashboard Creator | ✅ Ya |
Dashboard Editor | ❌ Tidak |
Dashboard Viewer | ❌ Tidak |
Other Company Users | ❌ Tidak |
Respons Kesalahan
Dashboard Tidak Ditemukan
{
"errors": [{
"message": "Dashboard not found",
"extensions": {
"code": "NOT_FOUND"
}
}]
}
Izin Tidak Cukup
{
"errors": [{
"message": "You don't have permission to edit this dashboard",
"extensions": {
"code": "FORBIDDEN"
}
}]
}
Kesalahan Validasi
{
"errors": [{
"message": "Dashboard title cannot be empty",
"extensions": {
"code": "VALIDATION_ERROR"
}
}]
}
Catatan Penting
- Tidak ada mutasi ganti nama terpisah: Tidak ada mutasi
renameDashboard
. Penggantian nama ditangani melalui mutasieditDashboard
- Izin hanya untuk pencipta: Hanya pencipta dashboard yang dapat menggantinya, bahkan jika pengguna lain memiliki peran EDITOR
- Validasi judul: Judul dashboard harus berupa string yang tidak kosong
- Operasi atomik: Saat memperbarui judul dan pengguna, semua perubahan berhasil atau tidak ada yang diterapkan
- Manajemen pengguna: Anda dapat menambahkan, memperbarui, atau menghapus pengguna dashboard dalam operasi yang sama dengan mengganti nama
Kasus Penggunaan
- Rebranding dashboard: Perbarui nama dashboard untuk mencerminkan terminologi atau branding perusahaan yang baru
- Pembaruan musiman: Ganti nama dashboard untuk mencerminkan periode waktu saat ini (misalnya, "Penjualan Q3 2024" → "Penjualan Q4 2024")
- Evolusi proyek: Perbarui judul dashboard saat proyek berubah ruang lingkup atau fokus
- Peningkatan kejelasan: Ganti nama dashboard agar lebih deskriptif atau mengikuti konvensi penamaan
Operasi Terkait
- Daftar Dashboard - Ambil semua dashboard untuk perusahaan atau proyek
- Buat Dashboard - Buat dashboard baru
- Hapus Dashboard - Hapus dashboard
- Salin Dashboard - Duplikat dashboard yang ada