使用 Blue API 更新現有儀表板的標題
重新命名儀表板
editDashboard
突變允許您通過更新標題來重新命名儀表板。只有儀表板的創建者有權重新命名儀表板。
基本示例
mutation RenameDashboard {
editDashboard(
input: {
id: "dash_abc123"
title: "Q4 Sales Dashboard"
}
) {
id
title
updatedAt
}
}
具有用戶管理的高級示例
editDashboard
突變在重新命名的同時也可以更新儀表板用戶:
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
}
}
輸入參數
EditDashboardInput
參數 | 類型 | 必需 | 描述 |
---|---|---|---|
id |
String! | ✅ 是 | 要重新命名的儀表板的唯一標識符 |
title |
String | 否 | 儀表板的新標題。如果未提供,標題保持不變 |
dashboardUsers |
[EditDashboardUserInput!] | 否 | 可選數組以更新儀表板用戶權限 |
EditDashboardUserInput
參數 | 類型 | 必需 | 描述 |
---|---|---|---|
userId |
String! | ✅ 是 | 要添加或更新的用戶 ID |
role |
DashboardRole! | ✅ 是 | 要分配給用戶的角色 |
DashboardRole 值
值 | 描述 |
---|---|
EDITOR |
可以查看和編輯儀表板內容(圖表、過濾器、佈局) |
VIEWER |
只能查看儀表板 |
響應字段
該突變返回一個完整的 Dashboard
對象:
字段 | 類型 | 描述 |
---|---|---|
id |
String! | 唯一的儀表板標識符 |
title |
String! | 更新後的儀表板標題 |
createdBy |
User! | 創建儀表板的用戶 |
dashboardUsers |
[DashboardUser!]! | 有權訪問儀表板的用戶列表 |
createdAt |
DateTime! | 儀表板創建的時間 |
updatedAt |
DateTime! | 儀表板最後修改的時間 |
所需權限
只有 儀表板創建者 可以重新命名儀表板。其他具有編輯者或查看者角色的用戶無法更改儀表板標題。
用戶類型 | 可以重新命名儀表板 |
---|---|
Dashboard Creator | ✅ 是 |
Dashboard Editor | ❌ 否 |
Dashboard Viewer | ❌ 否 |
Other Company Users | ❌ 否 |
錯誤響應
找不到儀表板
{
"errors": [{
"message": "Dashboard not found",
"extensions": {
"code": "NOT_FOUND"
}
}]
}
權限不足
{
"errors": [{
"message": "You don't have permission to edit this dashboard",
"extensions": {
"code": "FORBIDDEN"
}
}]
}
驗證錯誤
{
"errors": [{
"message": "Dashboard title cannot be empty",
"extensions": {
"code": "VALIDATION_ERROR"
}
}]
}
重要說明
- 沒有單獨的重命名突變:沒有
renameDashboard
突變。重命名通過editDashboard
突變處理 - 僅限創建者的權限:只有儀表板創建者可以重新命名,即使其他用戶具有編輯者角色
- 標題驗證:儀表板標題必須是非空字符串
- 原子操作:在同時更新標題和用戶時,要麼所有更改成功,要麼不應用任何更改
- 用戶管理:您可以在與重命名相同的操作中添加、更新或刪除儀表板用戶
用例
- 重新品牌儀表板:更新儀表板名稱以反映新的公司術語或品牌
- 季節性更新:重新命名儀表板以反映當前時間段(例如,“2024年第三季度銷售”→“2024年第四季度銷售”)
- 項目演變:隨著項目範圍或重點的變化更新儀表板標題
- 清晰度改進:重新命名儀表板以使其更具描述性或遵循命名約定