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분기 판매").
- 프로젝트 진화: 프로젝트의 범위나 초점이 변경됨에 따라 대시보드 제목을 업데이트합니다.
- 명확성 개선: 대시보드의 이름을 더 설명적이거나 명명 규칙에 따르도록 변경합니다.