Admin - Imports GetImportsAsAdmin

Служба:
Power BI REST APIs
Версия API:
v1.0

Возвращает список импорта для организации.

Разрешения

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

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

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

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

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

Ограничения

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

GET https://api.powerbi.com/v1.0/myorg/admin/imports
С использованием необязательных параметров: 
GET https://api.powerbi.com/v1.0/myorg/admin/imports?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

Параметры URI

Имя В Обязательно Тип Описание
$expand
 query

string

Расширяет встроенные связанные сущности
$filter
 query

string

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

integer (int32)

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

integer (int32)

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

Ответы

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

Imports

ХОРОШО

Примеры

Example

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

GET https://api.powerbi.com/v1.0/myorg/admin/imports

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

Код состояния:
200 
{
  "value": [
    {
      "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
      "importState": "Succeeded",
      "createdDateTime": "2018-05-08T14:56:18.477Z",
      "updatedDateTime": "2018-05-08T14:56:18.477Z",
      "name": "SalesMarketing",
      "connectionType": "import",
      "source": "Upload",
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
        }
      ],
      "reports": [
        {
          "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"
        }
      ]
    }
  ]
}

Определения

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

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

Параметры масштабирования запросов набора данных
DatasetUser

Запись права доступа пользователя Power BI для набора данных
DatasetUserAccessRight

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

Зависимый поток данных Power BI
Encryption

Сведения о шифровании для набора данных
EncryptionStatus

Состояние шифрования набора данных
Import

Объект импорта
ImportError

Сведения об ошибке для неудачного импорта
Imports

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

Подробные сведения об ответе на ошибку Power BI
PrincipalType

Тип субъекта
Report

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

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

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

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

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

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

Dataset

Объект

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

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

string

Тип поставщика контента для семантической модели.

Следующие contentProviderType хранятся в домашнем регионе клиента:

ContentProviderType
Excel
CSV
UsageMetricsUserReport
UsageMetricsUserDashboard
RealTimeInPushMode
RealTimeInPubNubMode
RealTimeInStreamingMode

Следующие contentProviderType хранятся в регионе емкости:

ContentProviderType
PowerBIDesktop
PowerBIModelingService
PbixInImportMode
PbixInDirectQueryMode
PbixInCompositeMode
InImportMode
InDirectQueryMode
InCompositeMode
Encryption

Encryption

Сведения о шифровании набора данных. Применимо только при указании $expand.
addRowsAPIEnabled

boolean

Позволяет ли набор данных добавлять новые строки
configuredBy

string

Владелец набора данных
createReportEmbedURL

string

URL-адрес внедрения отчета в набор данных
createdDate

string (date-time)

Дата и время создания набора данных
description

string

Описание набора данных
id

string

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

boolean

Требуется ли для набора данных эффективное удостоверение, которое необходимо отправить в вызов API GenerateTo ken.
isEffectiveIdentityRolesRequired

boolean

Определяется ли безопасность на уровне строк внутри PBIX-файла Power BI. В этом случае необходимо указать роль.
isInPlaceSharingEnabled

boolean

Может ли набор данных использоваться внешними пользователями в собственном клиенте.
isOnPremGatewayRequired

boolean

Требуется ли для набора данных локальный шлюз данных
isRefreshable

boolean

Это поле возвращает true, если набор данных недавно обновлен или настроен для автоматического обновления, при этом режим подключения специально установлен в значение Import. Значение возвращает false для других режимов подключения, таких как DirectQuery и LiveConnection, независимо от того, обновляется ли набор данных вручную или настроен для автоматического обновления.
name

string

Имя набора данных
qnaEmbedURL

string

Url-адрес внедрения набора данных Q&A
queryScaleOutSettings

DatasetQueryScaleOutSettings

Параметры масштабирования запросов набора данных
targetStorageMode

string

Режим хранения набора данных
upstreamDataflows

DependentDataflow[]

Список всех потоков данных этого элемента зависит от
users

DatasetUser[]

(Пустое значение) Сведения о доступе пользователя к набору данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователе в элементе Power BI (например, отчете или панели мониторинга) с помощью API Получения пользователей набора данных в качестве администратора или API PostWorkspaceInfo с параметром getArtifactUsers.
webUrl

string

URL-адрес веб-набора данных

DatasetQueryScaleOutSettings

Объект

Параметры масштабирования запросов набора данных

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

boolean

Автоматически ли набор данных синхронизирует реплики только для чтения
maxReadOnlyReplicas

integer

minimum: -1
maximum: 64

Максимальное количество реплик только для чтения для набора данных (0–64, -1 для автоматического числа реплик)

DatasetUser

Объект

Запись права доступа пользователя Power BI для набора данных

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

DatasetUserAccessRight

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

string

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

string

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

string

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

string

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

PrincipalType

Тип субъекта
profile

ServicePrincipalProfile

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

string

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

DatasetUserAccessRight

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

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

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

Удаляет разрешение на содержимое в наборе данных
Read

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

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

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

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

Предоставляет доступ на чтение и изучение содержимого в наборе данных
ReadReshareExplore

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

Предоставляет доступ на чтение, запись и изучение содержимого в наборе данных
ReadWriteReshareExplore

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

DependentDataflow

Объект

Зависимый поток данных Power BI

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

string

Идентификатор целевой группы
targetDataflowId

string

Идентификатор целевого потока данных

Encryption

Объект

Сведения о шифровании для набора данных

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

EncryptionStatus

Состояние шифрования набора данных

EncryptionStatus

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

Состояние шифрования набора данных

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

Состояние шифрования неизвестно из-за повреждения набора данных
NotSupported

Шифрование не поддерживается для этого набора данных
InSyncWithWorkspace

Шифрование поддерживается и синхронизируется с параметрами шифрования.
NotInSyncWithWorkspace

Шифрование поддерживается, но не синхронизируется с параметрами шифрования.

Import

Объект

Объект импорта

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

string (date-time)

Импорт даты и времени создания
datasets

Dataset[]

Наборы данных, связанные с этим импортом
error

ImportError

Сведения об ошибке при сбое импорта
id

string (uuid)

Идентификатор импорта
importState enum:
  • Failed
  • Publishing
  • Succeeded

Состояние отправки импорта
name

string

Имя импорта
reports

Report[]

Отчеты, связанные с этим импортом
updatedDateTime

string (date-time)

Импорт даты и времени последнего обновления

ImportError

Объект

Сведения об ошибке для неудачного импорта

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

string

Код ошибки
details

PowerBIApiErrorResponseDetail[]

Массив сведений об ошибках

Imports

Объект

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

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

string

Контекст OData
value

Import[]

Коллекция импорта

PowerBIApiErrorResponseDetail

Объект

Подробные сведения об ответе на ошибку Power BI

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

string

Код ошибки
message

string

Сообщение об ошибке
target

string

Целевой объект ошибки

PrincipalType

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

Тип субъекта

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

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

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

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

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

Report

Объект

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

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

string

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

string

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

string

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

string

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

string

Тип формата определения отчета. Для PowerBIReport:

Для PaginatedReport:
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-адрес веб-отчета

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

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

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

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

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

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

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

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

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