Partager via

Reports - Export To File

  • Référence
Service:
Power BI REST APIs
Version d'API:
v1.0

Exporte le rapport spécifié de Mon espace de travail au format de fichier demandé.

L’API est asynchrone. Lorsque l’API est appelée, elle déclenche un travail d’exportation. Après avoir déclenché un travail d’exportation, utilisez 'API GetExportToFileStatus pour suivre l’état du travail. En savoir plus sur l’ensemble du flux : Exporter des rapports Power BI et Exporter des rapports paginés

Étendue requise

Toutes les opérations suivantes :

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

Limites

Vérifiez les limitations de Exporter le rapport Power BI vers le fichier et Exporter le rapport paginé vers le fichier. 

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

Paramètres URI

Nom Dans Obligatoire Type Description
reportId
 path True

string (uuid)

ID de rapport

Corps de la demande

Nom Obligatoire Type Description
format True

FileFormat

Format demandé pour le fichier exporté
paginatedReportConfiguration

PaginatedReportExportConfiguration

Configuration utilisée pour exporter un rapport paginé
powerBIReportConfiguration

PowerBIReportExportConfiguration

Configuration utilisée pour exporter un rapport Power BI

Réponses

Nom Type Description
202 Accepted

Export

Accepté

Définitions

Nom Description
EffectiveIdentity

Définit l’identité et les rôles de l’utilisateur. Pour plus d’informations, consultez sécurité au niveau des lignes avec Power BI Embedded.
Export

Objet décrivant les détails et l’état actuel d’une exportation vers un travail de fichier
ExportFilter

Filtre à appliquer pendant l’opération d’exportation
ExportReportPage

Configuration d’une page unique pour la demande d’exportation
ExportReportRequest

Exportation vers la demande de fichier
ExportReportSettings

Exporter vers les paramètres de demande de fichier
ExportState

État actuel de l’exportation vers le travail de fichier
FileFormat

Format demandé pour le fichier exporté
IdentityBlob

Objet blob pour spécifier une identité. Uniquement pris en charge pour les jeux de données avec une connexion DirectQuery à Azure SQL
PageBookmark

Signet à appliquer sur une seule page. Indiquez le nom ou l’état, mais pas les deux.
PaginatedReportExportConfiguration

Exportation vers la configuration de fichier pour un rapport paginé
ParameterValue

Contrat de données pour les paramètres de rapport paginés
PowerBIReportExportConfiguration

Exportation vers la configuration de fichier pour un rapport Power BI

EffectiveIdentity

Object

Définit l’identité et les rôles de l’utilisateur. Pour plus d’informations, consultez sécurité au niveau des lignes avec Power BI Embedded.

Nom Type Description
auditableContext

string

Contexte auditable EffectiveIdentity. Si ce paramètre est fourni et n’est pas vide, il active l’audit de l’EffectiveIdentity et sa valeur est définie sur le nom d’utilisateur dans l’enregistrement d’audit. Sinon, le contexte EffectiveIdentity est omis à partir de l’enregistrement d’audit GenerateToken.
customData

string

données personnalisées utilisées pour appliquer des règles de sécurité au niveau des lignes. Prise en charge pour la connexion dynamique aux modèles Azure Analysis Services et aux modèles cloud uniquement.
datasets

string[]

Tableau de jeux de données pour lesquels cette identité s’applique
identityBlob

IdentityBlob

Objet blob qui spécifie une identité . Uniquement pris en charge pour les jeux de données avec une connexion DirectQuery à Azure SQL.
reports

string[]

Tableau de rapports pour lesquels cette identité s’applique. Uniquement pris en charge pour les rapports paginés.
roles

string[]

Tableau de rôles de sécurité au niveau des lignes (RLS) au sein d’un jeton qui applique des règles de sécurité au niveau des lignes. Une identité peut contenir jusqu’à 50 rôles. Un rôle peut contenir n’importe quel caractère, sauf ,, et sa longueur ne doit pas dépasser 50 caractères.
username

string

Nom d’utilisateur effectif dans un jeton qui applique des règles de sécurité au niveau des lignes. Pour un modèle local, le nom d’utilisateur peut contenir des caractères alphanumériques ou l’un des caractères suivants ., -, _, !, #, ^, ~, \\, @. Pour les modèles cloud, le nom d’utilisateur peut contenir n’importe quel caractère ASCII. Pour l’un ou l’autre modèle, la longueur du nom d’utilisateur ne doit pas dépasser 256 caractères et le nom d’utilisateur ne doit pas contenir d’espaces.

Export

Object

Objet décrivant les détails et l’état actuel d’une exportation vers un travail de fichier

Nom Type Description
createdDateTime

string (date-time)

Date et heure de début de l’exportation vers le travail de fichier
expirationTime

string (date-time)

Date et heure d’expiration de l’URL de récupération
id

string

Exportation vers l’ID du travail de fichier
lastActionDateTime

string (date-time)

Date et heure de la dernière modification de la tâche d’exportation vers le travail de fichier
percentComplete

integer (int32)

minimum: 0
maximum: 100

Progression du travail en pourcentage
reportId

string (uuid)

ID du rapport exporté
reportName

string

Nom du rapport exporté
resourceFileExtension

string

Extension du fichier exporté
resourceLocation

string

URL de récupération du fichier exporté
status

ExportState

État actuel de l’exportation vers le travail de fichier

ExportFilter

Object

Filtre à appliquer pendant l’opération d’exportation

Nom Type Description
filter

string

Filtre à appliquer. Pour plus d’informations sur la syntaxe de filtre, consultez Filtrer un rapport.

ExportReportPage

Object

Configuration d’une page unique pour la demande d’exportation

Nom Type Description
bookmark

PageBookmark

Signet à appliquer sur la page
pageName

string

Nom de la page
visualName

string

Nom du visuel à exporter. Spécifiez un nom, dans le cas où un seul visuel de cette page est exporté.

ExportReportRequest

Object

Exportation vers la demande de fichier

Nom Type Description
format

FileFormat

Format demandé pour le fichier exporté
paginatedReportConfiguration

PaginatedReportExportConfiguration

Configuration utilisée pour exporter un rapport paginé
powerBIReportConfiguration

PowerBIReportExportConfiguration

Configuration utilisée pour exporter un rapport Power BI

ExportReportSettings

Object

Exporter vers les paramètres de demande de fichier

Nom Type Description
includeHiddenPages

boolean

Indique s’il faut inclure des pages masquées lors de l’exportation d’un rapport entier. S’il n’est pas fourni, le comportement par défaut consiste à exclure les pages masquées. Cette propriété est ignorée lorsque des pages spécifiques sont exportées.
locale

string

Paramètres régionaux à appliquer

ExportState

Énumération

État actuel de l’exportation vers le travail de fichier

Valeur Description
Failed

Échec de l’exportation vers le travail de fichier
NotStarted

L’exportation vers le travail de fichier n’a pas démarré
Running

L’exportation vers le travail de fichier est en cours d’exécution
Succeeded

L’exportation vers le travail de fichier s’est terminée avec succès
Undefined

L’état de l’exportation vers le travail de fichier n’est pas défini

FileFormat

Énumération

Format demandé pour le fichier exporté

Valeur Description
ACCESSIBLEPDF

PDF accessible (pris en charge uniquement pour les rapports paginés)
CSV

CSV (pris en charge uniquement pour les rapports paginés)
DOCX

Microsoft Word (pris en charge uniquement pour les rapports paginés)
IMAGE

BMP, EMF, GIF, JPEG, PNG ou TIFF formats d’image (pris en charge uniquement pour les rapports paginés)
MHTML

MHTML (pris en charge uniquement pour les rapports paginés)
PDF

PDF
PNG

PNG (pris en charge uniquement pour les rapports Power BI)
PPTX

Microsoft PowerPoint
XLSX

Microsoft Excel (pris en charge uniquement pour les rapports paginés)
XML

XML (pris en charge uniquement pour les rapports paginés)

IdentityBlob

Object

Objet blob pour spécifier une identité. Uniquement pris en charge pour les jeux de données avec une connexion DirectQuery à Azure SQL

Nom Type Description
value

string

Jeton d’accès OAuth 2.0 pour Azure SQL

PageBookmark

Object

Signet à appliquer sur une seule page. Indiquez le nom ou l’état, mais pas les deux.

Nom Type Description
name

string

Nom du signet
state

string

État du signet

PaginatedReportExportConfiguration

Object

Exportation vers la configuration de fichier pour un rapport paginé

Nom Type Description
formatSettings

object

Dictionnaire des paramètres de format. Les clés sont les noms des propriétés d’informations sur l’appareil pour le format de fichier demandé.
identities

EffectiveIdentity[]

Identité unique à utiliser lors de l’exportation d’un rapport. Obligatoire lorsqu’un rapport utilise un jeu de données Power BI ou une source de données Azure Analysis Services.
locale

string

Paramètres régionaux à appliquer
parameterValues

ParameterValue[]

Liste des paramètres de rapport

ParameterValue

Object

Contrat de données pour les paramètres de rapport paginés

Nom Type Description
name

string

Nom du paramètre
value

string

Valeur du paramètre

PowerBIReportExportConfiguration

Object

Exportation vers la configuration de fichier pour un rapport Power BI

Nom Type Description
datasetToBind

string

ID de jeu de données avec lequel exporter le rapport. Nécessaire uniquement si vous exportez avec un jeu de données autre que le jeu de données par défaut du rapport.
defaultBookmark

PageBookmark

Signet par défaut à appliquer sur toutes les pages qui n’ont pas de signet spécifique
identities

EffectiveIdentity[]

Liste des identités à utiliser pour les règles de sécurité au niveau des lignes
pages

ExportReportPage[]

Liste des pages à exporter et leurs propriétés. La même page peut apparaître plusieurs fois avec des visuels différents.
reportLevelFilters

ExportFilter[]

Liste des filtres au niveau du rapport à appliquer. Actuellement, un seul filtre est pris en charge.
settings

ExportReportSettings

Paramètres à appliquer pour l’exportation vers le travail de fichier