Atualize o título de um painel existente usando a API Blue
Renomear um Painel
A mutação editDashboard
permite que você renomeie um painel atualizando seu título. Apenas o criador do painel tem permissão para renomear um painel.
Exemplo Básico
mutation RenameDashboard {
editDashboard(
input: {
id: "dash_abc123"
title: "Q4 Sales Dashboard"
}
) {
id
title
updatedAt
}
}
Exemplo Avançado com Gerenciamento de Usuários
A mutação editDashboard
também pode atualizar os usuários do painel enquanto renomeia:
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 | Obrigatório | Descrição |
---|---|---|---|
id |
String! | ✅ Sim | O identificador único do painel a ser renomeado |
title |
String | Não | O novo título para o painel. Se não fornecido, o título permanece inalterado |
dashboardUsers |
[EditDashboardUserInput!] | Não | Array opcional para atualizar as permissões dos usuários do painel |
EditDashboardUserInput
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
userId |
String! | ✅ Sim | O ID do usuário a ser adicionado ou atualizado |
role |
DashboardRole! | ✅ Sim | O papel a ser atribuído ao usuário |
Valores de DashboardRole
Valor | Descrição |
---|---|
EDITOR |
Pode visualizar e editar o conteúdo do painel (gráficos, filtros, layout) |
VIEWER |
Pode apenas visualizar o painel |
Campos de Resposta
A mutação retorna um objeto completo Dashboard
:
Campo | Tipo | Descrição |
---|---|---|
id |
String! | Identificador único do painel |
title |
String! | O título atualizado do painel |
createdBy |
User! | O usuário que criou o painel |
dashboardUsers |
[DashboardUser!]! | Lista de usuários com acesso ao painel |
createdAt |
DateTime! | Quando o painel foi criado |
updatedAt |
DateTime! | Quando o painel foi modificado pela última vez |
Permissões Necessárias
Apenas o criador do painel pode renomear um painel. Outros usuários com papéis de EDITOR ou VISUALIZADOR não podem alterar o título do painel.
Tipo de Usuário | Pode Renomear o Painel |
---|---|
Dashboard Creator | ✅ Sim |
Dashboard Editor | ❌ Não |
Dashboard Viewer | ❌ Não |
Other Company Users | ❌ Não |
Respostas de Erro
Painel Não Encontrado
{
"errors": [{
"message": "Dashboard not found",
"extensions": {
"code": "NOT_FOUND"
}
}]
}
Permissões Insuficientes
{
"errors": [{
"message": "You don't have permission to edit this dashboard",
"extensions": {
"code": "FORBIDDEN"
}
}]
}
Erro de Validação
{
"errors": [{
"message": "Dashboard title cannot be empty",
"extensions": {
"code": "VALIDATION_ERROR"
}
}]
}
Notas Importantes
- Sem mutação de renomeação separada: Não há mutação
renameDashboard
. A renomeação é tratada através da mutaçãoeditDashboard
- Permissão apenas para criadores: Apenas o criador do painel pode renomeá-lo, mesmo que outros usuários tenham o papel de EDITOR
- Validação de título: Os títulos dos painéis devem ser strings não vazias
- Operação atômica: Ao atualizar tanto o título quanto os usuários, todas as alterações devem ser bem-sucedidas ou nenhuma será aplicada
- Gerenciamento de usuários: Você pode adicionar, atualizar ou remover usuários do painel na mesma operação de renomeação
Casos de Uso
- Rebranding de painéis: Atualize os nomes dos painéis para refletir a nova terminologia ou branding da empresa
- Atualizações sazonais: Renomeie os painéis para refletir períodos de tempo atuais (por exemplo, "Vendas Q3 2024" → "Vendas Q4 2024")
- Evolução de projetos: Atualize os títulos dos painéis à medida que os projetos mudam de escopo ou foco
- Melhorias de clareza: Renomeie os painéis para serem mais descritivos ou seguir convenções de nomenclatura
Operações Relacionadas
- Listar Painéis - Recupere todos os painéis de uma empresa ou projeto
- Criar Painel - Crie um novo painel
- Excluir Painel - Remova um painel
- Copiar Painel - Duplicar um painel existente