Reports - Get Reports In Group

  • Ссылка
Service:
Power BI REST APIs
API Version:
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

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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/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

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

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