使用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年第四季度销售”)
- 项目演变:随着项目范围或重点的变化,更新仪表板标题
- 清晰度改进:重命名仪表板以使其更具描述性或遵循命名约定