Imports - Post Import In Group

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

Создает новое содержимое в указанной рабочей области.

Примечание.

Поддерживаемая содержимое:

  • Power BI PBIX-файлы
  • JSON-файлы (.json)
  • файлы Excel (.xlsx)
  • Файлы языка определения отчета (RDL)
  • Чтобы импортировать файл, укажите тип контента многопартийные и формы-данные в заголовках запроса и закодируйте файл как данные формы в тексте запроса. Задайте datasetDisplayName имя файла, включая его расширение (например, MyReport.pbix, ). report.rdl
  • Чтобы импортировать файл отчета с разбивкой на страницы (RDL), включите .rdl расширение ( datasetDisplayName например, paginatedReport.rdl). Для nameConflict, используйте Abort или Overwrite только.
  • Чтобы импортировать файл .xlsx из OneDrive для бизнеса, укажите тип контента application/json в заголовках запроса. Включите ImportInfo с filePath для пути к файлу .xlsx в тексте запроса. Не устанавливайте datasetDisplayName параметр запроса для этого метода импорта.
  • Чтобы импортировать большие Power BI PBIX-файлы размером от 1 ГБ до 10 ГБ, укажите тип контента application/json и включите ImportInfo с fileUrl url-адрес подписи общего доступа, полученный из Create Temporary Upload Location In Group. Задайте datasetDisplayName имя с расширением .pbix . Это поддерживается только для рабочих областей емкости Premium. Пример см. в сценарии Импорта больших файлов PowerShell.
  • Чтобы создать поток данных из файла model.json, установите datasetDisplayName значение model.json. Для nameConflict, используйте Abort или GenerateUniqueName только.

Разрешения

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

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

Dataset.ReadWrite.All

Ограничения

  • Потоки данных с субъектом-службой не поддерживаются.
  • Импорт PBIX-файла Power BI из OneDrive не поддерживается.
  • Импорт файла с защищенной меткой конфиденциальности не поддерживается для субъектов-служб.
  • Для импорта с помощью временного расположения отправки (fileUrl) требуется рабочая область емкости Premium.
  • Параметр datasetDisplayName не поддерживается при импорте книг Excel из OneDrive для бизнеса через filePath. 

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}
С использованием необязательных параметров: 
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

Параметры URI

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

string (uuid)

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

string

Отображаемое имя набора данных, включая расширение файла (например, MyReport.pbix, report.rdl). Требуется для multipart/form-data отправки и fileUrl импорта. Не поддерживается при импорте из OneDrive для бизнеса через filePath. Для импорта или создания потоков данных задайте для этого значениеmodel.json.
nameConflict
 query

ImportConflictHandlerMode

Указывает, что делать, если набор данных с тем же именем уже существует. Значение по умолчанию — Ignore. Для файлов RDL используйте Abort или Overwrite только. Для потоков данных model.json файлов используйте Abort или GenerateUniqueName только.
overrideModelLabel
 query

boolean

Определяет, следует ли переопределить существующую метку в модели при повторной публикации Power BI PBIX-файла. Значение по умолчанию службы — true.
overrideReportLabel
 query

boolean

Следует ли переопределить существующую метку в отчете при повторной публикации Power BI PBIX-файла. Значение по умолчанию службы — true.
skipReport
 query

boolean

Следует ли пропускать импорт отчета. Если задано, значение должно быть true. Поддерживается только для Power BI PBIX-файлов.
subfolderObjectId
 query

string (uuid)

Идентификатор вложенной папки для импорта файла в вложенную папку.

Текст запроса

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

connectionType

Тип подключения импорта для файла OneDrive для бизнеса
filePath

string

Путь к импорту файла OneDrive для бизнеса Excel (.xlsx), который может быть абсолютным или относительным. Power BI PBIX-файлы не поддерживаются.
fileUrl

string

URL-адрес подписанного URL-адреса временного хранилища BLOB-объектов, используемого для импорта больших Power BI PBIX-файлов в диапазоне от 1 ГБ до 10 ГБ.

Ответы

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

Import

ХОРОШО
202 Accepted

Import

Принято

Примеры

Import dataflow model.json example
Post import example
Post import skip report example

Import dataflow model.json example

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

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True
Текст запроса
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data name=model.json; filename=model.json Content-Type: application/json [Contents of Model JSON Encoded] --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

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

Код состояния:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

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

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Текст запроса
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

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

Код состояния:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import skip report example

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

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
Текст запроса
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

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

Код состояния:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Определения

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

Тип подключения импорта для файла OneDrive для бизнеса
Dataset

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

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

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

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

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

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

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

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

Указывает, что делать, если набор данных с тем же именем уже существует. Значение по умолчанию — Ignore. Для файлов RDL используйте Abort или Overwrite только. Для потоков данных model.json файлов используйте Abort или GenerateUniqueName только.
ImportError

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

Сведения об импорте
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 электронной почты

connectionType

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

Тип подключения импорта для файла OneDrive для бизнеса

Значение Описание
import
connect

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

Определяется ли безопасность на уровне строк в Power BI PBIX-файле. В этом случае необходимо указать роль.
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 Get Dataset Users as Admin или 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)

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

ImportConflictHandlerMode

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

Указывает, что делать, если набор данных с тем же именем уже существует. Значение по умолчанию — Ignore. Для файлов RDL используйте Abort или Overwrite только. Для потоков данных model.json файлов используйте Abort или GenerateUniqueName только.

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

Если набор данных с тем же именем уже существует, операция импорта создаст новый набор данных с тем же именем.
Abort

Если набор данных или поток данных с тем же именем уже существует, операция импорта будет отменена.
Overwrite

Если набор данных с тем же именем уже существует, операция импорта заменит существующий набор данных новым. Операция импорта завершится ошибкой, если конфликт не существует или имеется несколько существующих наборов данных с тем же именем.
CreateOrOverwrite

Если набор данных с тем же именем уже существует, операция импорта заменит существующий набор данных новым. Операция импорта завершится ошибкой, если существует несколько существующих наборов данных с одинаковым именем.
GenerateUniqueName

Если поток данных с тем же именем уже существует, операция импорта создаст новое уникальное имя для нового потока данных.

ImportError

Объект

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

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

string

Код ошибки
details

PowerBIApiErrorResponseDetail[]

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

ImportInfo

Объект

Сведения об импорте

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

connectionType

Тип подключения импорта для файла OneDrive для бизнеса
filePath

string

Путь к импорту файла OneDrive для бизнеса Excel (.xlsx), который может быть абсолютным или относительным. Power BI PBIX-файлы не поддерживаются.
fileUrl

string

URL-адрес подписанного URL-адреса временного хранилища BLOB-объектов, используемого для импорта больших Power BI PBIX-файлов в диапазоне от 1 ГБ до 10 ГБ.

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 Get Report Subscriptions as Admin API.
users

ReportUser[]

(Пустое значение) Сведения о доступе пользователя для отчета Power BI. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях отчета Power BI с помощью вызова API Get Report Users as Admin API или вызова API PostWorkspaceInfo API с помощью параметра 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 или панели мониторинга с помощью подписок Get Report Subscriptions As Admin или Get Dashboard Subscriptions As Admin 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

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