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


Admin - Reports GetReportsInGroupAsAdmin

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

Разрешения

  • Пользователь должен быть администратором Fabric или пройти проверку подлинности с помощью субъекта-службы.
  • Поддерживаются делегированные разрешения.

При выполнении в рамках проверки подлинности службы приложения не должны иметь необходимые разрешения администратора для Power BI, заданные на портале Azure.

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

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

Важно только при проверке подлинности через стандартный делегированный маркер доступа администратора. Не должно присутствовать при использовании проверки подлинности через субъект-службу.

Ограничения

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

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/reports
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/reports?$filter={$filter}&$top={$top}&$skip={$skip}

Параметры URI

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

string (uuid)

Идентификатор рабочей области

$filter
query

string

Возвращает подмножество результатов на основе условия параметра запроса Odata Odata фильтра.

$skip
query

integer (int32)

Пропускает первые результаты n

$top
query

integer (int32)

Возвращает только первые результаты n

Ответы

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

AdminReports

ХОРОШО

Примеры

Example

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

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

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

{
  "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"
    }
  ]
}

Определения

Имя Описание
AdminReport

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

AdminReports

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

PrincipalType

Тип субъекта

ReportUser

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

ReportUserAccessRight

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

ServicePrincipalProfile

Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.

Subscription

Подписка по электронной почте для элемента Power BI (например, отчета или панели мониторинга)

SubscriptionUser

Пользователь подписки на электронную почту Power BI

AdminReport

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

Имя Тип Описание
appId

string

Идентификатор приложения, возвращенный только в том случае, если отчет принадлежит приложению

createdBy

string

Владелец отчета. Доступно только для отчетов, созданных после июня 2019 года.

createdDateTime

string (date-time)

Дата и время создания отчета

datasetId

string

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

description

string

Описание отчета

embedUrl

string

URL-адрес внедрения отчета

id

string (uuid)

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

isOwnedByMe

boolean

Указывает, имеет ли текущий пользователь возможность изменять или создавать копию отчета.

modifiedBy

string

Последний пользователь, изменивший отчет

modifiedDateTime

string (date-time)

Дата и время последнего изменения отчета

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-адрес веб-отчета

workspaceId

string (uuid)

Идентификатор рабочей области (GUID) отчета. Это свойство будет возвращено только в GetReportsAsAdmin.

AdminReports

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

Имя Тип Описание
@odata.context

string

Контекст OData

value

AdminReport[]

Коллекция отчетов

PrincipalType

Тип субъекта

Значение Описание
App

Тип субъекта-службы

Group

Тип субъекта-группы

None

Нет типа субъекта. Используется для доступа на уровне всей организации.

User

Тип субъекта-пользователя

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

Нет разрешения на содержимое в отчете

Owner

Предоставляет доступ к содержимому в отчете для чтения, записи и повторного доступа к содержимому

Read

Предоставляет доступ на чтение к содержимому в отчете

ReadCopy

Предоставление доступа к содержимому в отчете для чтения и копирования

ReadReshare

Предоставление доступа к содержимому в отчете для чтения и повторного доступа к содержимому

ReadWrite

Предоставляет доступ на чтение и запись к содержимому в отчете

ServicePrincipalProfile

Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.

Имя Тип Описание
displayName

string

Имя профиля субъекта-службы

id

string (uuid)

Идентификатор профиля субъекта-службы

Subscription

Подписка по электронной почте для элемента 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

Пользователь подписки на электронную почту Power BI

Имя Тип Описание
displayName

string

Отображаемое имя субъекта

emailAddress

string

Адрес электронной почты пользователя

graphId

string

Идентификатор субъекта в Microsoft Graph. Доступно только для API администрирования.

identifier

string

Идентификатор субъекта

principalType

PrincipalType

Тип субъекта

profile

ServicePrincipalProfile

Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.

userType

string

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