Reports - Get Reports

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

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

Этот API также возвращает общие отчеты и отчеты из общих приложений. Доступ к отчетам, которые находятся в общих рабочих областях, можно получить с помощью API получения отчетов в группе.

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

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

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

GET https://api.powerbi.com/v1.0/myorg/reports

Ответы

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

Примеры

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/reports

Sample Response

Status code:: 200

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

Определения

Имя	Описание
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	string	Тип субъекта-службы
Group	string	Тип участника группы
None	string	Нет типа субъекта. Используйте для доступа на уровне всей организации.
User	string	Тип участника-пользователя

Report

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

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

Reports

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

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

ReportUser

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

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