Reports - Export To File

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

Экспортирует указанный отчет из раздела Моя рабочая область в запрошенный формат файла.

API является асинхронным. При вызове API запускается задание экспорта. После активации задания экспорта используйте API GetExportToFileStatus для отслеживания состояния задания. Дополнительные сведения обо всем потоке см. в статье Экспорт отчетов Power BI и Экспорт отчетов с разбивкой на страницы.

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

Все следующее:

Report.ReadWrite.All или Report.Read.All
Dataset.ReadWrite.All или Dataset.Read.All

Ограничения

Проверьте ограничения в разделе Экспорт отчета Power BI в файл и Экспорт отчета с разбивкой на страницы в файл.

POST https://api.powerbi.com/v1.0/myorg/reports/{reportId}/ExportTo

Параметры URI

Имя	В	Обязательно	Тип	Описание
reportId	path	True	string uuid	Идентификатор отчета

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

Имя	Обязательно	Тип	Описание
format	True	FileFormat	Запрошенный формат экспортированного файла
paginatedReportConfiguration		PaginatedReportExportConfiguration	Конфигурация, используемая для экспорта отчета с разбивкой на страницы
powerBIReportConfiguration		PowerBIReportExportConfiguration	Конфигурация, используемая для экспорта отчета Power BI

Ответы

Имя	Тип	Описание
202 Accepted	Export	Принято

Определения

Имя	Описание
EffectiveIdentity	Определяет удостоверение пользователя и роли. Дополнительные сведения см. в статье Безопасность на уровне строк с помощью Power BI Embedded.
Export	Объект , описывающий сведения и текущее состояние задания экспорта в файл
ExportFilter	Фильтр, применяемый во время операции экспорта
ExportReportPage	Одностраничная конфигурация для запроса на экспорт
ExportReportRequest	Запрос на экспорт в файл
ExportReportSettings	Параметры запроса экспорта в файл
ExportState	Текущее состояние задания экспорта в файл
FileFormat	Запрошенный формат экспортированного файла
IdentityBlob	Большой двоичный объект для указания удостоверения. Поддерживается только для наборов данных с подключением DirectQuery к Azure SQL
PageBookmark	Закладка, применяемая на одной странице. Укажите имя или состояние, но не оба.
PaginatedReportExportConfiguration	Конфигурация экспорта в файл для отчета с разбивкой на страницы
ParameterValue	Контракт данных для параметров отчета с разбивкой на страницы
PowerBIReportExportConfiguration	Конфигурация экспорта в файл для отчета Power BI

EffectiveIdentity

Определяет удостоверение пользователя и роли. Дополнительные сведения см. в статье Безопасность на уровне строк с помощью Power BI Embedded.

Имя	Тип	Описание
auditableContext	string	Контекст, доступный для аудита EffectiveIdentity. Если этот параметр указан и не пуст, он включает аудит EffectiveIdentity, а его значение будет равно имени пользователя в записи аудита. В противном случае контекст EffectiveIdentity будет пропущен из записи аудита GenerateToken.
customData	string	Пользовательские данные , используемые для применения правил безопасности на уровне строк. Поддерживается только для динамического подключения к Azure Analysis Services моделям и облачным моделям.
datasets	string[]	Массив наборов данных, к которым применяется это удостоверение.
identityBlob	IdentityBlob	Большой двоичный объект, указывающий удостоверение. Поддерживается только для наборов данных с подключением DirectQuery к Azure SQL.
reports	string[]	Массив отчетов, к которым применяется это удостоверение. Поддерживается только для отчетов с разбивкой на страницы.
roles	string[]	Массив ролей безопасности на уровне строк (RLS) в маркере, который применяет правила RLS. Удостоверение может содержать до 50 ролей. Роль может содержать любой символ, кроме `,`, и ее длина не должна превышать 50 символов.
username	string	Действующее имя пользователя в токене, применяющем правила безопасности на уровне строк. Для локальной модели имя пользователя может содержать буквенно-цифровые или любой из следующих символов `.`, `-`, `_`, `!`, `\\#^~`. `@` Для облачных моделей имя пользователя может содержать любой символ ASCII. Для любой модели длина имени пользователя не должна превышать 256 символов, а имя пользователя не должно содержать пробелов.

Export

Объект , описывающий сведения и текущее состояние задания экспорта в файл

Имя	Тип	Описание
ResourceFileExtension	string	Расширение экспортированного файла
createdDateTime	string	Дата и время начала выполнения задания экспорта в файл
expirationTime	string	Дата и время окончания срока действия URL-адреса извлечения
id	string	Экспорт в файл идентификатора задания
lastActionDateTime	string	Дата и время последнего изменения задания экспорта в файл
percentComplete	integer	Ход выполнения задания в процентах
reportId	string	Идентификатор экспортированного отчета
reportName	string	Имя экспортированного отчета
resourceLocation	string	URL-адрес получения экспортированного файла
status	ExportState	Текущее состояние задания экспорта в файл

ExportFilter

Фильтр, применяемый во время операции экспорта

Имя	Тип	Описание
filter	string	Применяемый фильтр. Сведения о синтаксисе фильтра см. в разделе Фильтрация отчета.

ExportReportPage

Одностраничная конфигурация для запроса на экспорт

Имя	Тип	Описание
bookmark	PageBookmark	Закладка, применяемая на странице
pageName	string	Имя страницы
visualName	string	Имя экспортируемого визуального элемента. Укажите имя, если экспортируется только один визуальный элемент с этой страницы.

ExportReportRequest

Запрос на экспорт в файл

Имя	Тип	Описание
format	FileFormat	Запрошенный формат экспортированного файла
paginatedReportConfiguration	PaginatedReportExportConfiguration	Конфигурация, используемая для экспорта отчета с разбивкой на страницы
powerBIReportConfiguration	PowerBIReportExportConfiguration	Конфигурация, используемая для экспорта отчета Power BI

ExportReportSettings

Параметры запроса экспорта в файл

Имя	Тип	Описание
includeHiddenPages	boolean	Следует ли включать скрытые страницы при экспорте всего отчета. Если параметр не указан, по умолчанию используется исключение скрытых страниц. Это свойство будет игнорироваться при экспорте определенных страниц.
locale	string	Применяемый языковой стандарт

ExportState

Текущее состояние задания экспорта в файл

Имя	Тип	Описание
Failed	string	Сбой задания экспорта в файл
NotStarted	string	Задание экспорта в файл не запущено
Running	string	Выполняется задание экспорта в файл
Succeeded	string	Задание экспорта в файл успешно завершено
Undefined	string	Состояние задания экспорта в файл не определено

FileFormat

Запрошенный формат экспортированного файла

Имя	Тип	Описание
ACCESSIBLEPDF	string	PDF-файл со специальными возможностями (поддерживается только для отчетов с разбивкой на страницы)
CSV	string	CSV -файл (поддерживается только для отчетов с разбивкой на страницы)
DOCX	string	Microsoft Word (поддерживается только для отчетов с разбивкой на страницы)
IMAGE	string	Форматы изображений BMP, EMF, GIF, JPEG, PNG или TIFF (поддерживается только для отчетов с разбивкой на страницы)
MHTML	string	MHTML (поддерживается только для отчетов с разбивкой на страницы)
PDF	string	PDF
PNG	string	PNG (поддерживается только для отчетов Power BI)
PPTX	string	Microsoft PowerPoint
XLSX	string	Microsoft Excel (поддерживается только для отчетов с разбивкой на страницы)
XML	string	XML (поддерживается только для отчетов с разбивкой на страницы)

IdentityBlob

Большой двоичный объект для указания удостоверения. Поддерживается только для наборов данных с подключением DirectQuery к Azure SQL

Имя	Тип	Описание
value	string	Маркер доступа OAuth 2.0 для Azure SQL

PageBookmark

Закладка, применяемая на одной странице. Укажите имя или состояние, но не оба.

Имя	Тип	Описание
name	string	Имя закладки
state	string	Состояние закладки

PaginatedReportExportConfiguration

Конфигурация экспорта в файл для отчета с разбивкой на страницы

Имя	Тип	Описание
formatSettings	object	Словарь параметров формата. Ключи — это имена свойств сведений об устройстве для запрошенного формата файла.
identities	EffectiveIdentity[]	Одно удостоверение, используемое при экспорте отчета. Требуется, если отчет использует набор данных Power BI или источник данных Azure Analysis Services.
parameterValues	ParameterValue[]	Список параметров отчета

ParameterValue

Контракт данных для параметров отчета с разбивкой на страницы

Имя	Тип	Описание
name	string	Имя параметра
value	string	Значение параметра

PowerBIReportExportConfiguration

Конфигурация экспорта в файл для отчета Power BI

Имя	Тип	Описание
datasetToBind	string	Идентификатор набора данных для экспорта отчета. Требуется только при экспорте с набором данных, отличным от набора данных отчета по умолчанию.
defaultBookmark	PageBookmark	Закладка по умолчанию для применения на всех страницах без определенной закладки
identities	EffectiveIdentity[]	Список удостоверений, используемых для правил безопасности на уровне строк
pages	ExportReportPage[]	Список экспортируемых страниц и их свойства. Та же страница может отображаться несколько раз с разными визуальными элементами.
reportLevelFilters	ExportFilter[]	Список применяемых фильтров на уровне отчета. В настоящее время поддерживается только один фильтр.
settings	ExportReportSettings	Параметры, применяемые для задания экспорта в файл

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