Admin - Dashboards GetDashboardSubscriptionsAsAdmin

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

Возвращает список подписок на панели мониторинга и сведения о подписчике. Это вызов API предварительной версии.

Разрешения

Пользователь должен иметь права администратора (например, Office 365 глобального администратора или администратора службы Power BI) или пройти проверку подлинности с помощью субъекта-службы.
Поддерживаются делегированные разрешения.

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

Tenant.Read.All или Tenant.ReadWrite.All

Ограничения

Максимум 200 запросов в час.

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/subscriptions

Параметры URI

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

Ответы

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

Примеры

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/subscriptions

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424275",
      "title": "TestDashboardSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "artifactType": "Dashboard",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": false,
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ]
}

Определения

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

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.

Subscriptions

Оболочка ответа OData для подписок Power BI

Имя	Тип	Описание
odata.context	string
value	Subscription[]	Подписка на электронную почту Power BI

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	Тип пользователя.

Share via