Actualiza el título de un tablero existente utilizando la API de Blue
Renombrar un Tablero
La mutación editDashboard
te permite renombrar un tablero actualizando su título. Solo el creador del tablero tiene permiso para renombrar un tablero.
Ejemplo Básico
mutation RenameDashboard {
editDashboard(
input: {
id: "dash_abc123"
title: "Q4 Sales Dashboard"
}
) {
id
title
updatedAt
}
}
Ejemplo Avanzado con Gestión de Usuarios
La mutación editDashboard
también puede actualizar los usuarios del tablero mientras se renombra:
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
}
}
Parámetros de Entrada
EditDashboardInput
Parámetro | Tipo | Requerido | Descripción |
---|---|---|---|
id |
String! | ✅ Sí | El identificador único del tablero a renombrar |
title |
String | No | El nuevo título para el tablero. Si no se proporciona, el título permanece sin cambios |
dashboardUsers |
[EditDashboardUserInput!] | No | Array opcional para actualizar los permisos de usuario del tablero |
EditDashboardUserInput
Parámetro | Tipo | Requerido | Descripción |
---|---|---|---|
userId |
String! | ✅ Sí | El ID del usuario a agregar o actualizar |
role |
DashboardRole! | ✅ Sí | El rol a asignar al usuario |
Valores de DashboardRole
Valor | Descripción |
---|---|
EDITOR |
Puede ver y editar el contenido del tablero (gráficos, filtros, diseño) |
VIEWER |
Solo puede ver el tablero |
Campos de Respuesta
La mutación devuelve un objeto completo Dashboard
:
Campo | Tipo | Descripción |
---|---|---|
id |
String! | Identificador único del tablero |
title |
String! | El título actualizado del tablero |
createdBy |
User! | El usuario que creó el tablero |
dashboardUsers |
[DashboardUser!]! | Lista de usuarios con acceso al tablero |
createdAt |
DateTime! | Cuándo se creó el tablero |
updatedAt |
DateTime! | Cuándo se modificó por última vez el tablero |
Permisos Requeridos
Solo el creador del tablero puede renombrar un tablero. Otros usuarios con roles de EDITOR o VISOR no pueden cambiar el título del tablero.
Tipo de Usuario | Puede Renombrar el Tablero |
---|---|
Dashboard Creator | ✅ Sí |
Dashboard Editor | ❌ No |
Dashboard Viewer | ❌ No |
Other Company Users | ❌ No |
Respuestas de Error
Tablero No Encontrado
{
"errors": [{
"message": "Dashboard not found",
"extensions": {
"code": "NOT_FOUND"
}
}]
}
Permisos Insuficientes
{
"errors": [{
"message": "You don't have permission to edit this dashboard",
"extensions": {
"code": "FORBIDDEN"
}
}]
}
Error de Validación
{
"errors": [{
"message": "Dashboard title cannot be empty",
"extensions": {
"code": "VALIDATION_ERROR"
}
}]
}
Notas Importantes
- No hay mutación de renombrar separada: No hay
renameDashboard
mutación. El renombramiento se maneja a través de laeditDashboard
mutación. - Permiso solo para el creador: Solo el creador del tablero puede renombrarlo, incluso si otros usuarios tienen rol de EDITOR.
- Validación del título: Los títulos de los tableros deben ser cadenas no vacías.
- Operación atómica: Al actualizar tanto el título como los usuarios, o todos los cambios tienen éxito o ninguno se aplica.
- Gestión de usuarios: Puedes agregar, actualizar o eliminar usuarios del tablero en la misma operación que el renombramiento.
Casos de Uso
- Rebranding de tableros: Actualiza los nombres de los tableros para reflejar la nueva terminología o marca de la empresa.
- Actualizaciones estacionales: Renombra los tableros para reflejar los períodos de tiempo actuales (por ejemplo, "Ventas Q3 2024" → "Ventas Q4 2024").
- Evolución del proyecto: Actualiza los títulos de los tableros a medida que los proyectos cambian de alcance o enfoque.
- Mejoras de claridad: Renombra los tableros para que sean más descriptivos o sigan convenciones de nomenclatura.
Operaciones Relacionadas
- Listar Tableros - Recuperar todos los tableros para una empresa o proyecto.
- Crear Tablero - Crear un nuevo tablero.
- Eliminar Tablero - Eliminar un tablero.
- Copiar Tablero - Duplicar un tablero existente.