Reports - Get Reports In Group

Ссылка

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

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

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

Так как отчеты с разбивкой на страницы (RDL) не имеют набора данных, значение идентификатора набора данных в ответе API для отчетов с разбивкой на страницы не отображается.

Разрешения

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

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

Report.ReadWrite.All или Report.Read.All

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

Параметры URI

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

Ответы

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

Примеры

Example

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

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

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

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

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48"
    }
  ]
}

Определения

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

PrincipalType

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

Тип субъекта

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

Report

Object

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

Имя	Тип	Описание
appId	string	Идентификатор приложения, возвращенный только в том случае, если отчет принадлежит приложению
datasetId	string	Идентификатор набора данных отчета
description	string	Описание отчета
embedUrl	string	URL-адрес внедрения отчета
id	string (uuid)	Идентификатор отчета
isOwnedByMe	boolean	Указывает, имеет ли текущий пользователь возможность изменять или создавать копию отчета.
name	string	Имя отчета. Отчеты приложений начинаются с префикса [App].
originalReportId	string (uuid)	Фактический идентификатор отчета при публикации рабочей области в качестве приложения.
reportType	enum: PaginatedReport PowerBIReport	Тип отчета
subscriptions	Subscription[]	(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью вызова API получения подписок отчета в качестве администратора API.
users	ReportUser[]	(Пустое значение) Сведения о доступе пользователей к отчету Power BI. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях в отчете Power BI с помощью вызова API получения пользователей отчета в качестве администратора или вызова API PostWorkspaceInfo с параметром `getArtifactUsers`.
webUrl	string	URL-адрес веб-отчета

Reports

Object

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

Имя	Тип	Описание
@odata.context	string	Контекст OData
value	Report[]	Коллекция отчетов

ReportUser

Object

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

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

ReportUserAccessRight

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

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

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

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

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

Reports - Get Reports In Group

Разрешения

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

Параметры URI

Ответы

Примеры

Example

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

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

Определения

PrincipalType

Report

Reports

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser