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


Admin - Reports GetReportSubscriptionsAsAdmin

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

Разрешения

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

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

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

Ограничения

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

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Параметры URI

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

string

uuid

Идентификатор отчета

Ответы

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

Subscriptions

ОК

Примеры

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Sample Response

{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424274",
      "title": "TestReportSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "subArtifactDisplayName": "Team Scorecard",
      "artifactType": "Report",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": true,
      "attachmentFormat": "PNG",
      "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 Получение подписок на отчеты как Администратор или Получение подписок панели мониторинга как Администратор вызовов 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

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