Dashboards - Get Dashboards In Group

Служба:: Power BI REST APIs

Версия API:: v1.0

Возвращает список панелей мониторинга из указанной рабочей области.

Разрешения

Этот вызов API может вызываться профилем субъекта-службы. Дополнительные сведения см. в статье Профили субъекта-службы в Power BI Embedded.

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

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

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards

Параметры URI

Имя	В	Обязательно	Тип	Описание
groupId	path	True	string (uuid)	Идентификатор рабочей области

Ответы

Имя	Тип	Описание
200 OK	Dashboards	ХОРОШО

Примеры

Example

Образец запроса

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false
    }
  ]
}

Определения

Имя	Описание
Dashboard	Панель мониторинга Power BI. API возвращает подмножество из следующего списка свойств панели мониторинга. Подмножество зависит от вызываемого API, разрешений вызываемого абонента и доступности данных в базе данных Power BI.
Dashboards	Оболочка ответа OData для коллекции панелей мониторинга Power BI
DashboardUser	Правая запись доступа пользователя Power BI для панели мониторинга
DashboardUserAccessRight	Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)
PrincipalType	Тип субъекта
ServicePrincipalProfile	Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.
Subscription	Подписка по электронной почте для элемента Power BI (например, отчета или панели мониторинга)
SubscriptionUser	Пользователь подписки на электронную почту Power BI

Dashboard

Object

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

Имя	Тип	Описание
appId	string	Идентификатор приложения, возвращенный только в том случае, если панель мониторинга принадлежит приложению
displayName	string	Отображаемое имя панели мониторинга
embedUrl	string	URL-адрес внедрения панели мониторинга
id	string (uuid)	Идентификатор панели мониторинга
isReadOnly	boolean	Является ли панель мониторинга доступной только для чтения
subscriptions	Subscription[]	(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью вызова API получения подписок отчета в качестве администратора API.
users	DashboardUser[]	(Пустое значение) Сведения о доступе пользователя к панели мониторинга. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях на панели мониторинга Power BI с помощью вызова API получения пользователей панели мониторинга в качестве администратора или вызова API PostWorkspaceInfo с параметром `getArtifactUsers`.
webUrl	string	URL-адрес веб-панели мониторинга

Dashboards

Object

Оболочка ответа OData для коллекции панелей мониторинга Power BI

Имя	Тип	Описание
@odata.context	string	Контекст OData
value	Dashboard[]	Коллекция панелей мониторинга

DashboardUser

Object

Правая запись доступа пользователя 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	Нет разрешения на содержимое на панели мониторинга
Read	Предоставляет доступ на чтение к содержимому на панели мониторинга
ReadWrite	Предоставляет доступ на чтение и запись к содержимому на панели мониторинга
ReadReshare	Предоставляет доступ на чтение и повторное предоставление доступа к содержимому на панели мониторинга
ReadCopy	Предоставляет доступ на чтение и копирование содержимого на панели мониторинга
Owner	Предоставляет доступ к содержимому в отчете для чтения, записи и повторного доступа к содержимому

PrincipalType

Перечисление

Тип субъекта

Значение	Описание
None	Нет типа субъекта. Используется для доступа на уровне всей организации.
User	Тип субъекта-пользователя
Group	Тип субъекта-группы
App	Тип субъекта-службы

ServicePrincipalProfile

Object

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

Имя	Тип	Описание
displayName	string	Имя профиля субъекта-службы
id	string (uuid)	Идентификатор профиля субъекта-службы

Subscription

Object

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

Имя	Тип	Описание
artifactDisplayName	string	Имя подписанного элемента Power BI (например, отчета или панели мониторинга)
artifactId	string (uuid)	Идентификатор подписанного элемента Power BI (например, отчета или панели мониторинга)
artifactType	string	Тип элемента Power BI (например, `Report`, `Dashboard`или `Dataset`)
attachmentFormat	string	Формат отчета, присоединенного к подписке электронной почты
endDate	string (date-time)	Дата окончания и время подписки электронной почты
frequency	string	Частота подписки электронной почты
id	string (uuid)	Идентификатор подписки
isEnabled	boolean	Включена ли подписка на электронную почту
linkToContent	boolean	Существует ли ссылка на подписку электронной почты
previewImage	boolean	Наличие снимка экрана отчета в подписке электронной почты
startDate	string (date-time)	Дата начала и время подписки электронной почты
subArtifactDisplayName	string	Имя страницы подписанного элемента Power BI, если это отчет.
title	string	Имя приложения
users	SubscriptionUser[]	Сведения о каждом подписчике электронной почты. При использовании вызова API получения подписок пользователей от имени администратора возвращается возвращаемое значение пустого массива (NULL). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о подписке в отчете Или панели мониторинга Power BI с помощью получения подписок отчетов от имени администратора или получения подписок панели мониторинга от имени администратора вызовов API.

SubscriptionUser

Object

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

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта
emailAddress	string	Адрес электронной почты пользователя
graphId	string	Идентификатор субъекта в Microsoft Graph. Доступно только для API администрирования.
identifier	string	Идентификатор субъекта
principalType	PrincipalType	Тип субъекта
profile	ServicePrincipalProfile	Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.
userType	string	Тип пользователя.