Поделиться через


Apps - Get Dashboard

Возвращает указанную панель мониторинга из указанного приложения.

Требуемая область

Dashboard.ReadWrite.All или Dashboard.Read.All

Ограничения

Проверка подлинности субъекта-службы не поддерживается.

GET https://api.powerbi.com/v1.0/myorg/apps/{appId}/dashboards/{dashboardId}

Параметры URI

Имя В Обязательно Тип Описание
appId
path True

string

uuid

Идентификатор приложения

dashboardId
path True

string

uuid

Идентификатор панели мониторинга

Ответы

Имя Тип Описание
200 OK

Dashboard

ОК

Примеры

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/dashboards/{dashboardId}

Sample Response

{
  "appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "id": "03dac094-2ff8-47e8-b2b9-dedbbc4d22ac",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=335aee4b-7b38-48fd-9e2f-306c3fd67482&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ%3d%3d",
  "isReadOnly": false
}

Определения

Имя Описание
Dashboard

Панель мониторинга Power BI. API возвращает подмножество из следующего списка свойств панели мониторинга. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.

DashboardUser

Запись права доступа пользователя Power BI для панели мониторинга

DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)

PrincipalType

Тип участника

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.

Subscription

Подписка по электронной почте для элемента Power BI (например, отчета или панели мониторинга)

SubscriptionUser

Пользователь подписки электронной почты Power BI

Dashboard

Панель мониторинга Power BI. API возвращает подмножество из следующего списка свойств панели мониторинга. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.

Имя Тип Описание
appId

string

Идентификатор приложения, возвращаемый только в том случае, если панель мониторинга принадлежит приложению

displayName

string

Отображаемое имя панели мониторинга

embedUrl

string

URL-адрес внедрения панели мониторинга

id

string

Идентификатор панели мониторинга

isReadOnly

boolean

Указывает, доступна ли панель мониторинга только для чтения

subscriptions

Subscription[]

(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью команды Получить подписки на отчеты в качестве вызова API Администратор.

users

DashboardUser[]

(Пустое значение) Сведения о доступе пользователя к панели мониторинга. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о пользователях на панели мониторинга Power BI можно получить с помощью команды Получить пользователей панели мониторинга в качестве вызова API Администратор или вызова API PostWorkspaceInfo с параметром getArtifactUsers .

webUrl

string

URL-адрес веб-страницы панели мониторинга

DashboardUser

Запись права доступа пользователя Power BI для панели мониторинга

Имя Тип Описание
dashboardUserAccessRight

DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)

displayName

string

Отображаемое имя участника

emailAddress

string

Адрес электронной почты пользователя

graphId

string

Идентификатор участника в Microsoft Graph. Доступно только для api-интерфейсов администратора.

identifier

string

Идентификатор субъекта

principalType

PrincipalType

Тип участника

profile

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.

userType

string

Тип пользователя.

DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)

Имя Тип Описание
None

string

Нет разрешений на содержимое на панели мониторинга

Owner

string

Предоставляет доступ на чтение, запись и повторное предоставление общего доступа к содержимому в отчете

Read

string

Предоставляет доступ на чтение к содержимому на панели мониторинга

ReadCopy

string

Предоставляет доступ на чтение и копирование содержимого на панели мониторинга

ReadReshare

string

Предоставляет доступ на чтение и повторное предоставление общего доступа к содержимому на панели мониторинга

ReadWrite

string

Предоставляет доступ на чтение и запись к содержимому на панели мониторинга

PrincipalType

Тип участника

Имя Тип Описание
App

string

Тип субъекта-службы

Group

string

Тип участника группы

None

string

Нет типа субъекта. Используйте для доступа на уровне всей организации.

User

string

Тип участника-пользователя

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.

Имя Тип Описание
displayName

string

Имя профиля субъекта-службы

id

string

Идентификатор профиля субъекта-службы

Subscription

Подписка по электронной почте для элемента Power BI (например, отчета или панели мониторинга)

Имя Тип Описание
artifactDisplayName

string

Имя элемента Power BI, на который подписана подписка (например, отчет или панель мониторинга).

artifactId

string

Идентификатор элемента Power BI, на который подписана подписка (например, отчет или панель мониторинга).

artifactType

string

Тип элемента Power BI (например Report, , Dashboardили Dataset)

attachmentFormat

string

Формат отчета, вложенного в подписку электронной почты

endDate

string

Дата и время окончания подписки по электронной почте

frequency

string

Частота подписки электронной почты

id

string

Идентификатор подписки

isEnabled

boolean

Включена ли подписка на электронную почту

linkToContent

boolean

Существует ли ссылка на подписку в подписке электронной почты

previewImage

boolean

Существует ли снимок экрана отчета в подписке электронной почты

startDate

string

Дата и время начала подписки электронной почты

subArtifactDisplayName

string

Имя страницы элемента Power BI, на который подписана подписка, если это отчет.

title

string

Имя приложения

users

SubscriptionUser[]

Сведения о каждом подписчике электронной почты. При использовании вызова API Get User Subscriptions As Администратор возвращаемым значением является пустой массив (NULL). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке в отчете или панели мониторинга Power BI можно получить с помощью Администратор получения подписок на отчеты или получения подписок панели мониторинга как Администратор вызовов API.

SubscriptionUser

Пользователь подписки электронной почты Power BI

Имя Тип Описание
displayName

string

Отображаемое имя участника

emailAddress

string

Адрес электронной почты пользователя

graphId

string

Идентификатор участника в Microsoft Graph. Доступно только для api-интерфейсов администратора.

identifier

string

Идентификатор субъекта

principalType

PrincipalType

Тип участника

profile

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.

userType

string

Тип пользователя.