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! | ダッシュボードが最後に変更された日時 |
必要な権限
ダッシュボードの作成者のみがダッシュボードの名前を変更できます。EDITORまたはVIEWERの役割を持つ他のユーザーはダッシュボードのタイトルを変更できません。
ユーザータイプ | ダッシュボードの名前を変更できる |
---|---|
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
ミューテーションを通じて処理されます。 - 作成者専用の権限: ダッシュボードの作成者のみが名前を変更できます。他のユーザーがEDITOR役割を持っていても同様です。
- タイトルの検証: ダッシュボードのタイトルは空でない文字列でなければなりません。
- 原子的操作: タイトルとユーザーの両方を更新する場合、すべての変更が成功するか、いずれも適用されません。
- ユーザー管理: 名前変更と同じ操作でダッシュボードのユーザーを追加、更新、または削除できます。
ユースケース
- ダッシュボードのブランディング: 新しい会社の用語やブランディングを反映するためにダッシュボードの名前を更新します。
- 季節ごとの更新: 現在の期間を反映するためにダッシュボードの名前を変更します(例: "2024年第3四半期の売上" → "2024年第4四半期の売上")。
- プロジェクトの進化: プロジェクトの範囲や焦点が変わるにつれてダッシュボードのタイトルを更新します。
- 明確さの向上: より説明的または命名規則に従ったダッシュボードの名前を変更します。
関連操作
- ダッシュボードの一覧 - 会社またはプロジェクトのすべてのダッシュボードを取得します。
- ダッシュボードの作成 - 新しいダッシュボードを作成します。
- ダッシュボードの削除 - ダッシュボードを削除します。
- ダッシュボードのコピー - 既存のダッシュボードを複製します。