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

Reports - Export To File

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

Экспортирует указанный отчет из my workspace в запрошенный формат файла .

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 к SQL Azure
PageBookmark

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

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

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

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

EffectiveIdentity

Object

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

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

string

Контекст аудита EffectiveIdentity. Если этот параметр указан и не пуст, то он позволит выполнить аудит действующей идентификаторности, а его значение будет присвоено имени пользователя в записи аудита. В противном случае контекст EffectiveIdentity будет опущен из записи аудита GenerateToken.
customData

string

пользовательские данные, которые используются для применения правил безопасности на уровне строк. Поддерживается только для динамического подключения к моделям Azure Analysis Services и облачным моделям.
datasets

string[]

Массив наборов данных, для которых применяется это удостоверение
identityBlob

IdentityBlob

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

string[]

Массив отчетов, для которых применяется это удостоверение. Поддерживается только для отчетов с разбивкой на страницы.
roles

string[]

Массив ролей безопасности на уровне строк (RLS) в маркере, который применяет правила RLS. Удостоверение может содержать до 50 ролей. Роль может содержать любой символ, кроме ,, и ее длина не должна превышать 50 символов.
username

string

Эффективное имя пользователя в маркере, которое применяет правила безопасности на уровне строк. Для локальной модели имя пользователя может содержать буквенно-цифровые или любой из следующих символов ., -, _, !, #, ^, ~, \\, @. Для облачных моделей имя пользователя может содержать любой символ ASCII. Для любой модели длина имени пользователя не должна превышать 256 символов, а имя пользователя не должно содержать пробелы.

Export

Object

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

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

string (date-time)

Дата начала и время экспорта в задание файла
expirationTime

string (date-time)

Дата окончания срока действия и время URL-адреса извлечения
id

string

Экспорт в идентификатор задания файла
lastActionDateTime

string (date-time)

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

integer (int32)

minimum: 0
maximum: 100

Ход выполнения задания в процентах
reportId

string (uuid)

Идентификатор экспортированного отчета
reportName

string

Имя экспортированного отчета
resourceFileExtension

string

Расширение экспортированного файла
resourceLocation

string

URL-адрес извлечения экспортированного файла
status

ExportState

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

ExportFilter

Object

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

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

string

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

ExportReportPage

Object

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

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

PageBookmark

Закладка, применяемая на странице
pageName

string

Имя страницы
visualName

string

Имя экспортируемого визуального элемента. Укажите имя, если экспортируется только один визуальный элемент из этой страницы.

ExportReportRequest

Object

Экспорт в запрос на файл

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

FileFormat

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

PaginatedReportExportConfiguration

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

PowerBIReportExportConfiguration

Конфигурация, используемая для экспорта отчета Power BI

ExportReportSettings

Object

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

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

boolean

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

string

Языковой стандарт для применения

ExportState

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

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

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

Сбой экспорта в задание файла
NotStarted

Не было запущено экспорт в задание файла
Running

Выполняется экспорт в задание файла
Succeeded

Экспорт в задание файла успешно завершено
Undefined

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

FileFormat

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

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

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

Доступный PDF-файл (поддерживается только для отчетов с разбивкой на страницы)
CSV

CSV (поддерживается только для отчетов с разбивкой на страницы)
DOCX

Microsoft Word (поддерживается только для отчетов с разбивкой на страницы)
IMAGE

BMP, EMF, GIF, JPEG, PNG или TIFF форматы изображений (только для отчетов с разбивкой на страницы)
MHTML

MHTML (поддерживается только для отчетов с разбивкой на страницы)
PDF

PDF
PNG

PNG (поддерживается только для отчетов Power BI)
PPTX

Microsoft PowerPoint
XLSX

Microsoft Excel (поддерживается только для отчетов с разбивкой на страницы)
XML

XML (поддерживается только для отчетов с разбивкой на страницы)

IdentityBlob

Object

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

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

string

Маркер доступа OAuth 2.0 для SQL Azure

PageBookmark

Object

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

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

string

Имя закладки
state

string

Состояние закладки

PaginatedReportExportConfiguration

Object

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

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

object

Словарь параметров формата. Ключи — это имена свойств сведений об устройстве для запрошенного формата файла.
identities

EffectiveIdentity[]

Одно удостоверение, используемое при экспорте отчета. Требуется, если отчет использует набор данных Power BI или источник данных Служб Azure Analysis Services.
locale

string

Языковой стандарт для применения
parameterValues

ParameterValue[]

Список параметров отчета

ParameterValue

Object

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

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

string

Имя параметра
value

string

Значение параметра

PowerBIReportExportConfiguration

Object

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

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

string

Идентификатор набора данных для экспорта отчета. Требуется только при экспорте с помощью набора данных, отличного от набора данных по умолчанию отчета.
defaultBookmark

PageBookmark

Закладка по умолчанию применяется ко всем страницам, у которых нет определенной закладки
identities

EffectiveIdentity[]

Список удостоверений, используемых для правил безопасности на уровне строк
pages

ExportReportPage[]

Список страниц для экспорта и их свойств. Одна и та же страница может отображаться несколько раз с различными визуальными элементами.
reportLevelFilters

ExportFilter[]

Список фильтров уровня отчета для применения. В настоящее время поддерживается только один фильтр.
settings

ExportReportSettings

Параметры, применяемые для экспорта в задание файла