Reports - Export To File

Esporta il report specificato dall'area di lavoro personale nel formato di file richiesto.

L'API è asincrona. Quando l'API viene chiamata, attiva un processo di esportazione. Dopo aver attivato un processo di esportazione, usare l'API GetExportToFileStatus per tenere traccia dello stato del processo. Altre informazioni sull'intero flusso: Esportare report di Power BI ed esportare report impaginati

Ambito obbligatorio

Tutte le operazioni seguenti:

  • Report.ReadWrite.All o Report.Read.All
  • Dataset.ReadWrite.All o Dataset.Read.All

Limitazioni

Controllare le limitazioni in Esportare report di Power BI in file ed Esportare report impaginati in file.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
reportId
path True

string

uuid

The report ID

Corpo della richiesta

Nome Necessario Tipo Descrizione
format True

FileFormat

Formato richiesto per il file esportato

paginatedReportConfiguration

PaginatedReportExportConfiguration

Configurazione utilizzata per esportare un report impaginato

powerBIReportConfiguration

PowerBIReportExportConfiguration

Configurazione usata per esportare un report di Power BI

Risposte

Nome Tipo Descrizione
202 Accepted

Export

Accepted

Definizioni

Nome Descrizione
EffectiveIdentity

Definisce l'identità e i ruoli dell'utente. Per altre informazioni, vedere Sicurezza a livello di riga con Power BI Embedded.

Export

Oggetto che descrive i dettagli e lo stato corrente di un'esportazione in un processo di file

ExportFilter

Filtro da applicare durante l'operazione di esportazione

ExportReportPage

Configurazione a pagina singola per la richiesta di esportazione

ExportReportRequest

Richiesta di esportazione in file

ExportReportSettings

Esporta nelle impostazioni di richiesta file

ExportState

Stato corrente dell'esportazione nel processo di file

FileFormat

Formato richiesto per il file esportato

IdentityBlob

BLOB per specificare un'identità. Supportato solo per i set di dati con una connessione DirectQuery a Azure SQL

PageBookmark

Segnalibro da applicare in una singola pagina. Specificare il nome o lo stato, ma non entrambi.

PaginatedReportExportConfiguration

Configurazione dell'esportazione in file per un report impaginato

ParameterValue

Contratto dati per i parametri del report impaginati

PowerBIReportExportConfiguration

Configurazione dell'esportazione in file per un report di Power BI

EffectiveIdentity

Definisce l'identità e i ruoli dell'utente. Per altre informazioni, vedere Sicurezza a livello di riga con Power BI Embedded.

Nome Tipo Descrizione
auditableContext

string

Contesto controllabile effectiveIdentity. Se questo parametro viene specificato e non è vuoto, abiliterà il controllo di EffectiveIdentity e il relativo valore verrà impostato sul nome utente nel record di controllo. In caso contrario, il contesto EffectiveIdentity verrà omesso dal record di controllo GenerateToken.

customData

string

Dati personalizzati usati per applicare regole di sicurezza a livello di riga. Supportato solo per la connessione dinamica a modelli di Azure Analysis Services e modelli cloud.

datasets

string[]

Matrice di set di dati per cui si applica questa identità

identityBlob

IdentityBlob

BLOB che specifica un'identità. Supportato solo per i set di dati con una connessione DirectQuery a Azure SQL.

reports

string[]

Matrice di report per cui si applica questa identità. Supportato solo per i report impaginati.

roles

string[]

Matrice di ruoli di sicurezza a livello di riga all'interno di un token che applica regole di sicurezza a livello di riga. Un'identità può contenere fino a 50 ruoli. Un ruolo può contenere qualsiasi carattere ad eccezione ,di e la sua lunghezza non deve superare i 50 caratteri.

username

string

Nome utente effettivo all'interno di un token che applica regole di sicurezza a livello di riga. Per un modello locale, il nome utente può contenere caratteri alfanumerici o uno dei caratteri .seguenti, , , _#~!^-, . \\@ Per i modelli cloud, il nome utente può contenere qualsiasi carattere ASCII. Per entrambi i modelli, la lunghezza del nome utente non deve superare i 256 caratteri e il nome utente non deve contenere spazi.

Export

Oggetto che descrive i dettagli e lo stato corrente di un'esportazione in un processo di file

Nome Tipo Descrizione
ResourceFileExtension

string

Estensione del file esportato

createdDateTime

string

Data e ora di inizio dell'esportazione nel processo di file

expirationTime

string

Data e ora di scadenza dell'URL di recupero

id

string

ID processo di esportazione in file

lastActionDateTime

string

Data e ora dell'ultima modifica apportata al processo di esportazione nel file

percentComplete

integer

Stato del processo come percentuale

reportId

string

ID del report esportato

reportName

string

Nome del report esportato

resourceLocation

string

URL di recupero per il file esportato

status

ExportState

Stato corrente dell'esportazione nel processo di file

ExportFilter

Filtro da applicare durante l'operazione di esportazione

Nome Tipo Descrizione
filter

string

Filtro da applicare. Per informazioni sulla sintassi del filtro, vedere Filtrare un report.

ExportReportPage

Configurazione a pagina singola per la richiesta di esportazione

Nome Tipo Descrizione
bookmark

PageBookmark

Segnalibro da applicare nella pagina

pageName

string

Nome della pagina

visualName

string

Nome dell'oggetto visivo da esportare. Specificare un nome, nel caso in cui venga esportato un solo oggetto visivo da questa pagina.

ExportReportRequest

Richiesta di esportazione in file

Nome Tipo Descrizione
format

FileFormat

Formato richiesto per il file esportato

paginatedReportConfiguration

PaginatedReportExportConfiguration

Configurazione utilizzata per esportare un report impaginato

powerBIReportConfiguration

PowerBIReportExportConfiguration

Configurazione usata per esportare un report di Power BI

ExportReportSettings

Esporta nelle impostazioni di richiesta file

Nome Tipo Descrizione
includeHiddenPages

boolean

Indica se includere pagine nascoste durante l'esportazione di un intero report. Se non specificato, il comportamento predefinito consiste nell'escludere le pagine nascoste. Questa proprietà verrà ignorata quando vengono esportate pagine specifiche.

locale

string

Impostazioni locali da applicare

ExportState

Stato corrente dell'esportazione nel processo di file

Nome Tipo Descrizione
Failed

string

Il processo di esportazione nel file non è riuscito

NotStarted

string

Il processo di esportazione nel file non è stato avviato

Running

string

Il processo di esportazione nel file è in esecuzione

Succeeded

string

Il processo di esportazione nel file è stato completato correttamente

Undefined

string

Lo stato dell'esportazione nel processo di file non è definito

FileFormat

Formato richiesto per il file esportato

Nome Tipo Descrizione
ACCESSIBLEPDF

string

PDF accessibile (supportato solo per i report impaginati)

CSV

string

CSV (supportato solo per i report impaginati)

DOCX

string

Microsoft Word (supportato solo per i report impaginati)

IMAGE

string

Formati di immagine BMP, EMF, GIF, JPEG, PNG o TIFF (supportati solo per i report impaginati)

MHTML

string

MHTML (supportato solo per i report impaginati)

PDF

string

PDF

PNG

string

PNG (supportato solo per i report di Power BI)

PPTX

string

Microsoft PowerPoint

XLSX

string

Microsoft Excel (supportato solo per i report impaginati)

XML

string

XML (supportato solo per i report impaginati)

IdentityBlob

BLOB per specificare un'identità. Supportato solo per i set di dati con una connessione DirectQuery a Azure SQL

Nome Tipo Descrizione
value

string

Token di accesso OAuth 2.0 per Azure SQL

PageBookmark

Segnalibro da applicare in una singola pagina. Specificare il nome o lo stato, ma non entrambi.

Nome Tipo Descrizione
name

string

Nome del segnalibro

state

string

Stato del segnalibro

PaginatedReportExportConfiguration

Configurazione dell'esportazione in file per un report impaginato

Nome Tipo Descrizione
formatSettings

object

Dizionario delle impostazioni di formato. Le chiavi sono i nomi delle proprietà delle informazioni sul dispositivo per il formato di file richiesto.

identities

EffectiveIdentity[]

Singola identità da utilizzare per l'esportazione di un report. Obbligatorio quando un report usa un set di dati di Power BI o un'origine dati Azure Analysis Services.

parameterValues

ParameterValue[]

Elenco di parametri del report

ParameterValue

Contratto dati per i parametri del report impaginati

Nome Tipo Descrizione
name

string

Nome del parametro

value

string

Valore del parametro

PowerBIReportExportConfiguration

Configurazione dell'esportazione in file per un report di Power BI

Nome Tipo Descrizione
datasetToBind

string

ID del set di dati con cui esportare il report. È necessario solo se l'esportazione con un set di dati diverso dal set di dati predefinito del report.

defaultBookmark

PageBookmark

Segnalibro predefinito da applicare in tutte le pagine che non hanno un segnalibro specifico

identities

EffectiveIdentity[]

Elenco di identità da usare per le regole di sicurezza a livello di riga

pages

ExportReportPage[]

Elenco di pagine da esportare e relative proprietà. La stessa pagina può essere visualizzata più volte con oggetti visivi diversi.

reportLevelFilters

ExportFilter[]

Elenco di filtri a livello di report da applicare. Attualmente è supportato un solo filtro.

settings

ExportReportSettings

Impostazioni da applicare per il processo di esportazione in file