Apps - Get Dashboards

Ссылка

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

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

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

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

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

Ограничения

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
appId	path	True	string uuid	Идентификатор приложения

Ответы

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

Примеры

Example

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

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

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

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

{
  "value": [
    {
      "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.
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	Идентификатор панели мониторинга
isReadOnly	boolean	Указывает, доступна ли панель мониторинга только для чтения
subscriptions	Subscription[]	(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью команды Получить подписки на отчеты как Администратор вызов 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

Enumeration

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

Значение	Описание
None	Нет разрешений на содержимое на панели мониторинга
Owner	Предоставляет доступ на чтение, запись и повторное предоставление общего доступа к содержимому в отчете
Read	Предоставляет доступ на чтение к содержимому на панели мониторинга
ReadCopy	Предоставляет доступ на чтение и копирование содержимого на панели мониторинга
ReadReshare	Предоставление доступа для чтения и повторного доступа к содержимому на панели мониторинга
ReadWrite	Предоставляет доступ на чтение и запись к содержимому на панели мониторинга

PrincipalType

Enumeration

Тип субъекта

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

ServicePrincipalProfile

Object

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

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

Subscription

Object

Подписка электронной почты на элемент 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 Получение подписок на отчеты как Администратор или Получение подписок панели мониторинга как Администратор вызовов 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	Тип пользователя.

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

Apps - Get Dashboards

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

Ограничения

Параметры URI

Ответы

Примеры

Example

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

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

Определения

Dashboard

Dashboards

DashboardUser

DashboardUserAccessRight

PrincipalType

ServicePrincipalProfile

Subscription

SubscriptionUser

Дополнительные ресурсы