Reports - Export To File

Referência

Service:: Power BI REST APIs

API Version:: v1.0

Exporta o relatório especificado de Meu workspace para o formato de arquivo solicitado.

A API é assíncrona. Quando a API é chamada, ela dispara um trabalho de exportação. Depois de disparar um trabalho de exportação, use a API GetExportToFileStatus para acompanhar o trabalho status. Leia mais sobre todo o fluxo: Exportar relatórios do Power BI e Exportar relatórios paginados

Escopo necessário

Todos os seguintes:

Report.ReadWrite.All ou Report.Read.All
Dataset.ReadWrite.All ou Dataset.Read.All

Limitações

Verifique as limitações em Exportar relatório do Power BI para arquivo e Exportar relatório paginado para arquivo.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
reportId	path	True	string uuid	A ID do relatório

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
format	True	FileFormat	O formato solicitado para o arquivo exportado
paginatedReportConfiguration		PaginatedReportExportConfiguration	A configuração usada para exportar um relatório paginado
powerBIReportConfiguration		PowerBIReportExportConfiguration	A configuração usada para exportar um relatório do Power BI

Respostas

Nome	Tipo	Description
202 Accepted	Export	Aceito

Definições

Nome	Description
EffectiveIdentity	Define a identidade e as funções do usuário. Para obter mais informações, consulte Segurança em nível de linha com Power BI Embedded.
Export	Um objeto que descreve os detalhes e o estado atual de uma exportação para o trabalho de arquivo
ExportFilter	Um filtro a ser aplicado durante a operação de exportação
ExportReportPage	Uma configuração de página única para a solicitação de exportação
ExportReportRequest	A exportação para a solicitação de arquivo
ExportReportSettings	Exportar para configurações de solicitação de arquivo
ExportState	O estado atual da exportação para o trabalho de arquivo
FileFormat	O formato solicitado para o arquivo exportado
IdentityBlob	Um blob para especificar uma identidade. Só há suporte para conjuntos de dados com uma conexão DirectQuery com SQL do Azure
PageBookmark	O indicador a ser aplicado em uma única página. Forneça nome ou estado, mas não ambos.
PaginatedReportExportConfiguration	A configuração de exportação para arquivo para um relatório paginado
ParameterValue	Contrato de dados para parâmetros de relatório paginados
PowerBIReportExportConfiguration	A configuração de exportação para arquivo para um relatório do Power BI

EffectiveIdentity

Define a identidade e as funções do usuário. Para obter mais informações, consulte Segurança em nível de linha com Power BI Embedded.

Nome	Tipo	Description
auditableContext	string	O contexto auditável EffectiveIdentity. Se esse parâmetro for fornecido e não estiver vazio, ele habilitará a auditoria da EffectiveIdentity e seu valor será definido como o nome de usuário no registro de auditoria. Caso contrário, o contexto EffectiveIdentity será omitido do registro de auditoria GenerateToken.
customData	string	Dados personalizados usados para aplicar regras de segurança em nível de linha. Compatível apenas com a conexão dinâmica com modelos de Azure Analysis Services e modelos de nuvem.
datasets	string[]	Uma matriz de conjuntos de dados para os quais essa identidade se aplica
identityBlob	IdentityBlob	Um blob que especifica uma identidade. Há suporte apenas para conjuntos de dados com uma conexão DirectQuery com SQL do Azure.
reports	string[]	Uma matriz de relatórios para os quais essa identidade se aplica. Só há suporte para relatórios paginados.
roles	string[]	Uma matriz de funções RLS (segurança em nível de linha) dentro de um token que aplica regras RLS. Uma identidade pode conter até 50 funções. Uma função pode conter qualquer caractere, exceto `,`, e seu comprimento não deve exceder 50 caracteres.
username	string	O nome de usuário efetivo em um token que aplica regras de segurança em nível de linha. Para um modelo local, o nome de usuário pode conter alfanumérico ou qualquer um dos seguintes caracteres `.`, `-`, , `_`, `!`, `#`, `^`, `~`, , `\\`, . `@` Para modelos de nuvem, o nome de usuário pode conter qualquer caractere ASCII. Para qualquer um dos modelos, o comprimento do nome de usuário não deve exceder 256 caracteres e o nome de usuário não deve conter espaços.

Export

Um objeto que descreve os detalhes e o estado atual de uma exportação para o trabalho de arquivo

Nome	Tipo	Description
ResourceFileExtension	string	A extensão do arquivo exportado
createdDateTime	string	A data e a hora de início da exportação para o trabalho de arquivo
expirationTime	string	A data e a hora de expiração da URL de recuperação
id	string	A ID do trabalho de exportação para arquivo
lastActionDateTime	string	A data e a hora da última alteração para o trabalho de exportação para arquivo
percentComplete	integer	Progresso do trabalho como porcentagem
reportId	string	A ID do relatório exportado
reportName	string	O nome do relatório exportado
resourceLocation	string	A URL de recuperação do arquivo exportado
status	ExportState	O estado atual da exportação para o trabalho de arquivo

ExportFilter

Um filtro a ser aplicado durante a operação de exportação

Nome	Tipo	Description
filter	string	O filtro a ser aplicado. Para obter informações sobre a sintaxe do filtro, consulte Filtrar um relatório.

ExportReportPage

Uma configuração de página única para a solicitação de exportação

Nome	Tipo	Description
bookmark	PageBookmark	O indicador a ser aplicado na página
pageName	string	O nome da página
visualName	string	O nome do visual a ser exportado. Especifique um nome, caso apenas um único visual desta página seja exportado.

ExportReportRequest

A exportação para a solicitação de arquivo

Nome	Tipo	Description
format	FileFormat	O formato solicitado para o arquivo exportado
paginatedReportConfiguration	PaginatedReportExportConfiguration	A configuração usada para exportar um relatório paginado
powerBIReportConfiguration	PowerBIReportExportConfiguration	A configuração usada para exportar um relatório do Power BI

ExportReportSettings

Exportar para configurações de solicitação de arquivo

Nome	Tipo	Description
includeHiddenPages	boolean	Se deve incluir páginas ocultas ao exportar um relatório inteiro. Se não for fornecido, o comportamento padrão será excluir páginas ocultas. Essa propriedade será ignorada quando páginas específicas forem exportadas.
locale	string	A localidade a ser aplicada

ExportState

O estado atual da exportação para o trabalho de arquivo

Nome	Tipo	Description
Failed	string	Falha na exportação para o trabalho de arquivo
NotStarted	string	A exportação para o trabalho de arquivo não foi iniciada
Running	string	A exportação para o trabalho de arquivo está em execução
Succeeded	string	A exportação para o trabalho de arquivo foi concluída com êxito
Undefined	string	O estado da exportação para o trabalho de arquivo é indefinido

FileFormat

O formato solicitado para o arquivo exportado

Nome	Tipo	Description
ACCESSIBLEPDF	string	PDF acessível (com suporte apenas para relatórios paginados)
CSV	string	CSV (com suporte apenas para relatórios paginados)
DOCX	string	Microsoft Word (com suporte apenas para relatórios paginados)
IMAGE	string	Formatos de imagem BMP, EMF, GIF, JPEG, PNG ou TIFF (com suporte apenas para relatórios paginados)
MHTML	string	MHTML (com suporte apenas para relatórios paginados)
PDF	string	PDF
PNG	string	PNG (com suporte apenas para relatórios do Power BI)
PPTX	string	Microsoft PowerPoint
XLSX	string	Microsoft Excel (com suporte apenas para relatórios paginados)
XML	string	XML (com suporte apenas para relatórios paginados)

IdentityBlob

Um blob para especificar uma identidade. Só há suporte para conjuntos de dados com uma conexão DirectQuery com SQL do Azure

Nome	Tipo	Description
value	string	Um token de acesso OAuth 2.0 para SQL do Azure

PageBookmark

O indicador a ser aplicado em uma única página. Forneça nome ou estado, mas não ambos.

Nome	Tipo	Description
name	string	O nome do indicador
state	string	O estado do indicador

PaginatedReportExportConfiguration

A configuração de exportação para arquivo para um relatório paginado

Nome	Tipo	Description
formatSettings	object	Um dicionário de configurações de formato. As chaves são os nomes de propriedade de informações do dispositivo para o formato de arquivo solicitado.
identities	EffectiveIdentity[]	A única identidade a ser usada ao exportar um relatório. Necessário quando um relatório usa um conjunto de dados do Power BI ou uma fonte de dados Azure Analysis Services.
parameterValues	ParameterValue[]	Uma lista de parâmetros de relatório

ParameterValue

Contrato de dados para parâmetros de relatório paginados

Nome	Tipo	Description
name	string	O nome do parâmetro
value	string	O valor do parâmetro

PowerBIReportExportConfiguration

A configuração de exportação para arquivo para um relatório do Power BI

Nome	Tipo	Description
datasetToBind	string	A ID do conjunto de dados com a qual exportar o relatório. Necessário somente se for exportado com um conjunto de dados diferente do conjunto de dados padrão do relatório.
defaultBookmark	PageBookmark	Um indicador padrão a ser aplicado em todas as páginas que não têm um indicador específico
identities	EffectiveIdentity[]	Uma lista de identidades a serem usadas para regras de segurança em nível de linha
pages	ExportReportPage[]	Uma lista de páginas para exportar e suas propriedades. A mesma página pode aparecer mais de uma vez com visuais diferentes.
reportLevelFilters	ExportFilter[]	Uma lista de filtros de nível de relatório a serem aplicados. Atualmente, há suporte para apenas um filtro.
settings	ExportReportSettings	As configurações a serem aplicadas para o trabalho de exportação para arquivo

Compartilhar via