Partager via

Reports - Export To File In Group

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

Exporte le rapport spécifié de l’espace de travail spécifié 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 l’API GetExportToFileStatus pour suivre le status de travail. En savoir plus sur l’ensemble du flux : Exporter des rapports Power BI et Exporter des rapports paginés

Autorisations

Cet appel d’API peut être appelé par un profil de principal de service. Pour plus d’informations, consultez : Profils de principal de service dans Power BI Embedded.

É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 dans Exporter un rapport Power BI vers un fichier et Exporter un rapport paginé dans un fichier. 

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

Paramètres URI

Nom Dans Obligatoire Type Description
groupId
 path True

string

uuid

L’ID de l’espace de travail
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’un travail d’exportation vers un fichier
ExportFilter

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

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

Demande d’exportation vers un fichier
ExportReportSettings

Exporter vers les paramètres de demande de fichier
ExportState

État actuel du travail d’exportation vers le fichier
FileFormat

Format demandé pour le fichier exporté
IdentityBlob

Objet blob permettant de spécifier une identité. Pris en charge uniquement 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

Configuration d’exportation vers un fichier pour un rapport paginé
ParameterValue

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

Configuration de l’exportation vers un fichier pour un rapport Power BI

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.

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 sera omis 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. Pris 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é. Pris en charge uniquement pour les jeux de données avec une connexion DirectQuery à Azure SQL.
reports

string[]

Tableau de rapports pour lesquels cette identité s’applique. Pris en charge uniquement 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 RLS. Une identité peut contenir jusqu’à 50 rôles. Un rôle peut contenir n’importe quel caractère à l’exception ,de , 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 alphanumérique 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

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

Nom Type Description
ResourceFileExtension

string

Extension du fichier exporté
createdDateTime

string

Date et heure de début du travail d’exportation vers un fichier
expirationTime

string

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

string

ID de travail d’exportation vers le fichier
lastActionDateTime

string

Date et heure de la dernière modification apportée au travail d’exportation vers le fichier
percentComplete

integer

Progression du travail en pourcentage
reportId

string

ID du rapport exporté
reportName

string

Nom du rapport exporté
resourceLocation

string

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

ExportState

État actuel du travail d’exportation vers le fichier

ExportFilter

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

Configuration d’une seule page 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, au cas où un seul visuel de cette page est exporté.

ExportReportRequest

Demande d’exportation vers un 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

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

État actuel du travail d’exportation vers le fichier

Nom Type Description
Failed

string

Échec de la tâche d’exportation vers un fichier
NotStarted

string

Le travail d’exportation vers un fichier n’a pas démarré
Running

string

Le travail d’exportation vers un fichier est en cours d’exécution
Succeeded

string

Le travail d’exportation vers le fichier s’est terminé avec succès
Undefined

string

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

FileFormat

Format demandé pour le fichier exporté

Nom Type Description
ACCESSIBLEPDF

string

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

string

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

string

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

string

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

string

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

string

PDF
PNG

string

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

string

Microsoft PowerPoint
XLSX

string

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

string

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

IdentityBlob

Objet blob permettant de spécifier une identité. Pris en charge uniquement 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

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

Configuration d’exportation vers un fichier pour un rapport paginé

Nom Type Description
formatSettings

object

Dictionnaire des paramètres de format. Les clés sont les noms de 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.
parameterValues

ParameterValue[]

Liste des paramètres de rapport

ParameterValue

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

Configuration de l’exportation vers un 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 de 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 le travail d’exportation vers fichier