Reports - Export To File
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 da API GetExportToFileStatus para acompanhar o status do trabalho. 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 no relatório exportar Power BI para arquivar e exportar relatório paginado para o arquivo.
POST https://api.powerbi.com/v1.0/myorg/reports/{reportId}/ExportTo
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
report
|
path | True |
string (uuid) |
A ID do relatório |
Corpo da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| format | True |
O formato solicitado para o arquivo exportado |
|
| paginatedReportConfiguration |
A configuração usada para exportar um relatório paginado |
||
| powerBIReportConfiguration |
A configuração usada para exportar um relatório do Power BI |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 202 Accepted |
Aceitado |
Definições
| Nome | Description |
|---|---|
|
Effective |
Define a identidade e as funções do usuário. Para obter mais informações, consulte segurança em nível de linha com o Power BI Embedded. |
| Export |
Um objeto que descreve os detalhes e o estado atual de uma exportação para o trabalho de arquivo |
|
Export |
Um filtro a ser aplicado durante a operação de exportação |
|
Export |
Uma configuração de página única para a solicitação de exportação |
|
Export |
A exportação para a solicitação de arquivo |
|
Export |
Exportar para configurações de solicitação de arquivo |
|
Export |
O estado atual da exportação para o trabalho de arquivo |
|
File |
O formato solicitado para o arquivo exportado |
|
Identity |
Um blob para especificar uma identidade. Com suporte apenas para conjuntos de dados com uma conexão DirectQuery com o SQL do Azure |
|
Page |
O indicador a ser aplicado em uma única página. Forneça nome ou estado, mas não ambos. |
|
Paginated |
A exportação para a configuração de arquivo para um relatório paginado |
|
Parameter |
Contrato de dados para parâmetros de relatório paginados |
|
Power |
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 o Power BI Embedded.
Export
Um objeto que descreve os detalhes e o estado atual de uma exportação para o trabalho de arquivo
| Nome | Tipo | Description |
|---|---|---|
| createdDateTime |
string (date-time) |
A data e a hora de início da exportação para o trabalho de arquivo |
| expirationTime |
string (date-time) |
A data de validade e a hora da URL de recuperação |
| id |
string |
A exportação para a ID do trabalho de arquivo |
| lastActionDateTime |
string (date-time) |
A data e a hora da última alteração para a exportação para o trabalho de arquivo |
| percentComplete |
integer (int32) minimum: 0maximum: 100 |
Progresso do trabalho como porcentagem |
| reportId |
string (uuid) |
A ID do relatório exportado |
| reportName |
string |
O nome do relatório exportado |
| resourceFileExtension |
string |
A extensão do arquivo exportado |
| resourceLocation |
string |
A URL de recuperação do arquivo exportado |
| status |
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 |
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 dessa página seja exportado. |
ExportReportRequest
A exportação para a solicitação de arquivo
| Nome | Tipo | Description |
|---|---|---|
| format |
O formato solicitado para o arquivo exportado |
|
| paginatedReportConfiguration |
A configuração usada para exportar um relatório paginado |
|
| powerBIReportConfiguration |
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 deseja 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
| Valor | Description |
|---|---|
| Undefined |
O estado da exportação para o trabalho de arquivo é indefinido |
| NotStarted |
A exportação para o trabalho de arquivo não foi iniciada |
| Running |
A exportação para o trabalho de arquivo está em execução |
| Succeeded |
A exportação para o trabalho de arquivo foi concluída com êxito |
| Failed |
Falha na exportação para o trabalho de arquivo |
FileFormat
O formato solicitado para o arquivo exportado
| Valor | Description |
|---|---|
| PPTX |
Microsoft PowerPoint |
|
|
|
| PNG |
PNG (com suporte apenas para relatórios do Power BI) |
| IMAGE |
Formatos de imagem BMP, EMF, GIF, JPEG, PNG ou T IFF (com suporte apenas para relatórios paginados) |
| XLSX |
Microsoft Excel (com suporte apenas para relatórios paginados) |
| DOCX |
Microsoft Word (com suporte apenas para relatórios paginados) |
| CSV |
CSV (com suporte apenas para relatórios paginados) |
| XML |
XML (com suporte apenas para relatórios paginados) |
| MHTML |
MHTML (com suporte apenas para relatórios paginados) |
| ACCESSIBLEPDF |
PDF acessível (com suporte apenas para relatórios paginados) |
IdentityBlob
Um blob para especificar uma identidade. Com suporte apenas para conjuntos de dados com uma conexão DirectQuery com o 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 exportação para a configuração de 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 |
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 do Azure Analysis Services. |
|
| locale |
string |
A localidade a ser aplicada |
| parameterValues |
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 exportar com um conjunto de dados diferente do conjunto de dados padrão do relatório. |
| defaultBookmark |
Um indicador padrão a ser aplicado em todas as páginas que não têm um indicador específico |
|
| identities |
Uma lista de identidades a serem usadas para regras de segurança em nível de linha |
|
| pages |
Uma lista de páginas para exportar e suas propriedades. A mesma página pode aparecer mais de uma vez com visuais diferentes. |
|
| reportLevelFilters |
Uma lista de filtros de nível de relatório a serem aplicados. Atualmente, há suporte para apenas um filtro. |
|
| settings |
As configurações a serem aplicadas para a exportação para o trabalho de arquivo |