Обновите заголовок существующей панели инструментов с помощью API Blue
Переименование панели инструментов
Мутация 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
- Валидация заголовка: Заголовки панелей инструментов должны быть непустыми строками
- Атомарная операция: При обновлении как заголовка, так и пользователей, либо все изменения успешны, либо ни одно не применяется
- Управление пользователями: Вы можете добавлять, обновлять или удалять пользователей панели инструментов в той же операции, что и переименование
Сценарии использования
- Ребрендинг панелей инструментов: Обновите названия панелей инструментов, чтобы отразить новую терминологию или брендинг компании
- Сезонные обновления: Переименуйте панели инструментов, чтобы отразить текущие временные периоды (например, "Продажи Q3 2024" → "Продажи Q4 2024")
- Эволюция проекта: Обновите заголовки панелей инструментов по мере изменения объема или фокуса проектов
- Улучшение ясности: Переименуйте панели инструментов, чтобы они были более описательными или соответствовали правилам наименования
Связанные операции
- Список панелей инструментов - Получите все панели инструментов для компании или проекта
- Создать панель инструментов - Создайте новую панель инструментов
- Удалить панель инструментов - Удалите панель инструментов
- Копировать панель инструментов - Дублируйте существующую панель инструментов