Imports - Post Import In Group

  • Ссылка
Service:
Power BI REST APIs
API Version:
v1.0

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

Примечание

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

  • PBIX-файлы Power BI
  • JSON-файлы (.json)
  • Файлы Excel (XLSX)
  • SQL Server файлов языка определения отчетов (RDL)
  • Чтобы импортировать файл, укажите тип контента multipart/form-data в заголовках запроса и закодируйте файл как данные формы в тексте запроса.
  • Чтобы импортировать RDL-файл, включите расширение файла в имя, указанное в параметре datasetDisplayName, как описано в разделе Параметры URI.
  • Чтобы импортировать файл .xlsx из OneDrive для бизнеса, включите тип контента application/json в заголовки запроса. Включите ImportInfo с filePath параметром для .xlsx путь к файлу в тексте запроса.
  • Сведения об импорте больших PBIX-файлов Power BI размером от 1 ГБ до 10 ГБ см. в разделах Создание временного расположения отправки в группе и Сценарий PowerShell импорта больших файлов . Это поддерживается только для рабочих областей емкости Premium.
  • Чтобы создать поток данных из файла model.json, задайте для значение datasetDisplayNamemodel.json, как описано в разделе Параметры URI.

Разрешения

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

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

Dataset.ReadWrite.All

Ограничения

  • Потоки данных с субъектом-службой не поддерживаются.
  • Импорт PBIX-файла Power BI из OneDrive не поддерживается.
  • Импорт файла с защищенной меткой конфиденциальности не поддерживается для субъектов-служб. 

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}

Параметры URI

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

string

uuid

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

string

Отображаемое имя набора данных должно включать расширение файла. Не поддерживается при импорте из OneDrive для бизнеса. Для импорта или создания потоков данных этот параметр должен быть жестко задан для model.json.
nameConflict
 query

ImportConflictHandlerMode

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

boolean

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

boolean

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

boolean

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

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

Media Types: "application/json", "multipart/form-data"

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

connectionType

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

string

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

string

URL-адрес подписанного URL-адреса временного хранилища BLOB-объектов, используемого для импорта больших PBIX-файлов Power BI размером от 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

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True
Request Body
{
  "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--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import skip report example

Sample Request

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
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
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-файлов AbortOverwrite и являются единственными поддерживаемыми вариантами. Для потока данных model.json файлов и AbortGenerateUniqueName являются единственными поддерживаемыми вариантами.
ImportInfo

Сведения об импорте
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 для бизнеса

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

string

import

string

Dataset

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

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

string

Тип поставщика содержимого для набора данных
CreateReportEmbedURL

string

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

string

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

Encryption

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

boolean

Требуется ли для набора данных действующее удостоверение, которое необходимо отправить в вызове API GenerateToken .
IsEffectiveIdentityRolesRequired

boolean

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

boolean

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

boolean

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

boolean

Является ли набор данных обновляемым или нет. Обновляемый набор данных Power BI — это набор данных, который был обновлен по крайней мере один раз или для которого существует допустимое расписание обновления.
QnaEmbedURL

string

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

boolean

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

string

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

string

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

string

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

string

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

DatasetQueryScaleOutSettings

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

string

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

DependentDataflow[]

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

DatasetUser[]

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

string

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

DatasetQueryScaleOutSettings

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

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

boolean

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

integer

Максимальное число реплик только для чтения для набора данных (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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

DependentDataflow

Поток данных, зависимый от Power BI

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

string

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

string

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

Encryption

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

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

EncryptionStatus

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

EncryptionStatus

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

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

string

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

string

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

string

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

string

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

Import

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

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

string

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

Dataset[]

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

string

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

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

string

Имя импорта
reports

Report[]

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

string

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

ImportConflictHandlerMode

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

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

string

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

string

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

string

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

string

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

string

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

ImportInfo

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

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

connectionType

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

string

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

string

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

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

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

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