Partager via

Imports - Post Import

Service:
Power BI REST APIs
Version d'API:
v1.0

Crée du contenu dans Mon espace de travail.

Consultez la Importer des fichiers volumineux script PowerShell pour obtenir un exemple d’utilisation de cette API.

Remarque

Contenu pris en charge :

  • Fichiers .pbix Power BI
  • Fichiers JSON (.json)
  • Fichiers Excel (.xlsx)
  • Fichiers de langage de définition de rapport (.rdl)
  • Pour importer un fichier, spécifiez le type de contenu multipart/form-data dans les en-têtes de requête et encodez le fichier en tant que données de formulaire dans le corps de la requête.
  • Pour importer le fichier Rapports paginés (.rdl), incluez l’extension de fichier .rdl dans le nom spécifié par datasetDisplayName exemple paginatedReport.rdl, comme décrit dans les paramètres d’URI. L’extension de fichier dans le datasetDisplayName fichier permet de distinguer le chargement de rapport paginé(.rdl) à partir d’autres chargements.
  • Pour importer un fichier .xlsx à partir de OneDrive Entreprise, incluez le type de contenu application/json dans les en-têtes de requête. Incluez ImportInfo avec filePath défini sur le chemin du fichier .xlsx dans le corps de la requête.
  • Pour importer des fichiers .pbix Power BI volumineux compris entre 1 Go et 10 Go de taille, consultez Créer un emplacement de chargement temporaire. Cela n’est pris en charge que pour les espaces de travail de capacité Premium.
  • Pour créer un flux de données à partir d’un fichier model.json, définissez datasetDisplayName sur model.json, comme décrit dans paramètres d’URI.

Étendue requise

Dataset.ReadWrite.All

Limites

  • Les dataflows avec principal de service ne sont pas pris en charge.
  • L’importation d’un fichier .pbix Power BI à partir de OneDrive n’est pas prise en charge.
  • L’importation d’un fichier qui a une protégée étiquette de confidentialité n’est pas prise en charge pour les principaux de service. 

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}
Avec des paramètres facultatifs: 
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

Paramètres URI

Nom Dans Obligatoire Type Description
datasetDisplayName
 query True

string

Le nom complet du jeu de données doit inclure l’extension de fichier. Non pris en charge lors de l’importation à partir de OneDrive Entreprise.
nameConflict
 query

ImportConflictHandlerMode

Spécifie ce qu’il faut faire si un jeu de données portant le même nom existe déjà. La valeur par défaut est Ignore. Pour les fichiers RDL, Abort et Overwrite sont les seules options prises en charge et non d’autres.
overrideModelLabel
 query

boolean

Indique s’il faut remplacer l’étiquette existante sur un modèle lors de la republiation d’un fichier .pbix Power BI. La valeur par défaut du service est true.
overrideReportLabel
 query

boolean

Indique s’il faut remplacer l’étiquette de rapport existante lors de la republiation d’un fichier .pbix Power BI. La valeur par défaut du service est true.
skipReport
 query

boolean

Indique s’il faut ignorer l’importation de rapport. Si elle est spécifiée, la valeur doit être true. Uniquement pris en charge pour les fichiers .pbix Power BI.
subfolderObjectId
 query

string (uuid)

ID du sous-dossier à importer dans le sous-dossier.

Corps de la demande

Nom Type Description
connectionType

connectionType

Type de connexion d’importation pour un fichier OneDrive Entreprise
filePath

string

Chemin d’accès du fichier Excel OneDrive Entreprise (.xlsx) à importer, qui peut être absolu ou relatif. Les fichiers .pbix Power BI ne sont pas pris en charge.
fileUrl

string

URL de signature d’accès partagé du stockage blob temporaire utilisé pour importer des fichiers Power BI .pbix volumineux compris entre 1 Go et 10 Go de taille.

Réponses

Nom Type Description
200 OK

Import

D’ACCORD
202 Accepted

Import

Accepté

Exemples

Import dataflow example
Post import example
Post import with 'skipReport' example

Import dataflow example

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=model.json&nameConflict=Abort
Corps de la demande
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data name=model.json; filename=model.json Content-Type: application/json [Contents of Model JSON Encoded] --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Exemple de réponse

Code d’état:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Corps de la demande
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Exemple de réponse

Code d’état:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import with 'skipReport' example

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
Corps de la demande
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Exemple de réponse

Code d’état:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Définitions

Nom Description
connectionType

Type de connexion d’importation pour un fichier OneDrive Entreprise
Dataset

Jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante des propriétés du jeu de données. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.
DatasetQueryScaleOutSettings

Interroger les paramètres de scale-out d’un jeu de données
DatasetUser

Entrée de droit d’accès utilisateur Power BI pour un jeu de données
DatasetUserAccessRight

Droit d’accès que l’utilisateur a pour le jeu de données (niveau d’autorisation)
DependentDataflow

Flux de données dépendant de Power BI
Encryption

Informations de chiffrement pour un jeu de données
EncryptionStatus

État du chiffrement du jeu de données
Import

Objet d’importation
ImportConflictHandlerMode

Spécifie ce qu’il faut faire si un jeu de données portant le même nom existe déjà. La valeur par défaut est Ignore. Pour les fichiers RDL, Abort et Overwrite sont les seules options prises en charge et non d’autres.
ImportInfo

Informations sur l’importation
PrincipalType

Type de principal
Report

Rapport Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de rapport. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.
ReportUser

Entrée de droit d’accès utilisateur Power BI pour un rapport
ReportUserAccessRight

Droit d’accès dont l’utilisateur dispose pour le rapport (niveau d’autorisation)
ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
Subscription

Un abonnement par e-mail pour un élément Power BI (tel qu’un rapport ou un tableau de bord)
SubscriptionUser

Un utilisateur d’abonnement de messagerie Power BI

connectionType

Énumération

Type de connexion d’importation pour un fichier OneDrive Entreprise

Valeur Description
connect
import

Dataset

Object

Jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante des propriétés du jeu de données. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.

Nom Type Description
ContentProviderType

string

Propriété déconseillée qui doit être ignorée.
Encryption

Encryption

Informations de chiffrement du jeu de données. Applicable uniquement lorsque $expand est spécifié.
IsEffectiveIdentityRequired

boolean

Indique si le jeu de données nécessite une identité effective, que vous devez envoyer dans un appel d’API GenerateToken.
IsEffectiveIdentityRolesRequired

boolean

Indique si la sécurité au niveau des lignes est définie à l’intérieur du fichier .pbix Power BI. Dans ce cas, vous devez spécifier un rôle.
IsInPlaceSharingEnabled

boolean

Indique si le jeu de données peut être partagé avec des utilisateurs externes à consommer dans leur propre locataire
IsOnPremGatewayRequired

boolean

Indique si le jeu de données nécessite une passerelle de données locale
IsRefreshable

boolean

Ce champ retourne true lorsque le jeu de données est récemment actualisé ou configuré pour l’actualisation automatique, avec le mode de connexion spécifiquement défini sur « Importer ». La valeur retourne false pour d’autres modes de connexion, tels que « DirectQuery » et « LiveConnection », que le jeu de données soit actualisé manuellement ou configuré pour l’actualisation automatique.
addRowsAPIEnabled

boolean

Indique si le jeu de données autorise l’ajout de nouvelles lignes
configuredBy

string

Propriétaire du jeu de données
createReportEmbedURL

string

Le jeu de données crée une URL d’incorporation de rapport
createdDate

string (date-time)

Date et heure de création du jeu de données
description

string

Description du jeu de données
id

string

ID du jeu de données
name

string

Nom du jeu de données
qnaEmbedURL

string

Le jeu de données Q&UNE URL incorporée
queryScaleOutSettings

DatasetQueryScaleOutSettings

Interroger les paramètres de scale-out d’un jeu de données
targetStorageMode

string

Mode de stockage du jeu de données
upstreamDataflows

DependentDataflow[]

La liste de tous les flux de données dont dépend cet élément
users

DatasetUser[]

(Valeur vide) Détails de l’accès de l’utilisateur au jeu de données. Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations utilisateur sur un élément Power BI (tel qu’un rapport ou un tableau de bord) à l’aide du Obtenir des utilisateurs de jeu de données en tant qu’API d’administration, ou de l’API PostWorkspaceInfo avec le paramètre getArtifactUsers.
webUrl

string

URL web du jeu de données

DatasetQueryScaleOutSettings

Object

Interroger les paramètres de scale-out d’un jeu de données

Nom Type Description
autoSyncReadOnlyReplicas

boolean

Indique si le jeu de données synchronise automatiquement les réplicas en lecture seule
maxReadOnlyReplicas

integer

minimum: -1
maximum: 64

Nombre maximal de réplicas en lecture seule pour le jeu de données (0-64, -1 pour le nombre automatique de réplicas)

DatasetUser

Object

Entrée de droit d’accès utilisateur Power BI pour un jeu de données

Nom Type Description
datasetUserAccessRight

DatasetUserAccessRight

Droit d’accès que l’utilisateur a pour le jeu de données (niveau d’autorisation)
displayName

string

Nom complet du principal
emailAddress

string

Adresse e-mail de l’utilisateur
graphId

string

Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier

string

Identificateur du principal
principalType

PrincipalType

Type de principal
profile

ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType

string

Type de l’utilisateur.

DatasetUserAccessRight

Énumération

Droit d’accès que l’utilisateur a pour le jeu de données (niveau d’autorisation)

Valeur Description
None

Supprime l’autorisation du contenu dans le jeu de données
Read

Octroie l’accès en lecture au contenu dans le jeu de données
ReadExplore

Octroie l’accès en lecture et explorer au contenu du jeu de données
ReadReshare

Accorde l’accès en lecture et repartage au contenu du jeu de données
ReadReshareExplore

Accorde l’accès en lecture, repartage et exploration du contenu dans le jeu de données
ReadWrite

Octroie l’accès en lecture et écriture au contenu du jeu de données
ReadWriteExplore

Accorde l’accès en lecture, écriture et exploration au contenu du jeu de données
ReadWriteReshare

Accorde l’accès en lecture, écriture et partage à nouveau au contenu du jeu de données
ReadWriteReshareExplore

Accorde l’accès en lecture, écriture, partage et exploration du contenu dans le jeu de données

DependentDataflow

Object

Flux de données dépendant de Power BI

Nom Type Description
groupId

string

ID de groupe cible
targetDataflowId

string

ID de flux de données cible

Encryption

Object

Informations de chiffrement pour un jeu de données

Nom Type Description
EncryptionStatus

EncryptionStatus

État du chiffrement du jeu de données

EncryptionStatus

Énumération

État du chiffrement du jeu de données

Valeur Description
InSyncWithWorkspace

Le chiffrement est pris en charge et est synchronisé avec les paramètres de chiffrement
NotInSyncWithWorkspace

Le chiffrement est pris en charge, mais n’est pas synchronisé avec les paramètres de chiffrement
NotSupported

Le chiffrement n’est pas pris en charge pour ce jeu de données
Unknown

L’état du chiffrement est inconnu en raison de l’altération du jeu de données

Import

Object

Objet d’importation

Nom Type Description
createdDateTime

string (date-time)

Importer la date et l’heure de création
datasets

Dataset[]

Jeux de données associés à cette importation
id

string (uuid)

ID d’importation
importState enum:
  • Failed
  • Publishing
  • Succeeded

État de chargement d’importation
name

string

Nom de l’importation
reports

Report[]

Rapports associés à cette importation
updatedDateTime

string (date-time)

Importer la date et l’heure de la dernière mise à jour

ImportConflictHandlerMode

Énumération

Spécifie ce qu’il faut faire si un jeu de données portant le même nom existe déjà. La valeur par défaut est Ignore. Pour les fichiers RDL, Abort et Overwrite sont les seules options prises en charge et non d’autres.

Valeur Description
Abort

Si un jeu de données portant le même nom existe déjà, l’opération d’importation est annulée.
CreateOrOverwrite

Si un jeu de données portant le même nom existe déjà, l’opération d’importation remplace le jeu de données existant par le nouveau. L’opération d’importation échoue s’il existe plusieurs jeux de données existants portant le même nom.
GenerateUniqueName

Si un flux de données portant le même nom existe déjà, l’opération d’importation génère un nouveau nom unique pour le nouveau dataflow.
Ignore

Si un jeu de données portant le même nom existe déjà, l’opération d’importation crée un jeu de données portant le même nom.
Overwrite

Si un jeu de données portant le même nom existe déjà, l’opération d’importation remplace le jeu de données existant par le nouveau. L’opération d’importation échoue en l’absence de conflit ou s’il existe plusieurs jeux de données existants portant le même nom.

ImportInfo

Object

Informations sur l’importation

Nom Type Description
connectionType

connectionType

Type de connexion d’importation pour un fichier OneDrive Entreprise
filePath

string

Chemin d’accès du fichier Excel OneDrive Entreprise (.xlsx) à importer, qui peut être absolu ou relatif. Les fichiers .pbix Power BI ne sont pas pris en charge.
fileUrl

string

URL de signature d’accès partagé du stockage blob temporaire utilisé pour importer des fichiers Power BI .pbix volumineux compris entre 1 Go et 10 Go de taille.

PrincipalType

Énumération

Type de principal

Valeur Description
App

Type de principal de service
Group

Type de principal de groupe
None

Aucun type de principal. Utiliser pour l’ensemble de l’accès au niveau de l’organisation.
User

Type de principal de l’utilisateur

Report

Object

Rapport Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de rapport. Le sous-ensemble dépend de l’API appelée, des autorisations d’appelant et de la disponibilité des données dans la base de données Power BI.

Nom Type Description
appId

string

ID de l’application, retourné uniquement si le rapport appartient à une application
datasetId

string

ID de jeu de données du rapport
description

string

Description du rapport
embedUrl

string

URL incorporée du rapport
id

string (uuid)

ID de rapport
isOwnedByMe

boolean

Indique si l’utilisateur actuel a la possibilité de modifier ou de créer une copie du rapport.
name

string

Nom du rapport. Les rapports d’application commencent par le préfixe [Application].
originalReportId

string (uuid)

ID de rapport réel lorsque l’espace de travail est publié en tant qu’application.
reportType enum:
  • PaginatedReport
  • PowerBIReport

Type de rapport
subscriptions

Subscription[]

(Valeur vide) Détails de l’abonnement pour un élément Power BI (tel qu’un rapport ou un tableau de bord). Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations d’abonnement pour un rapport Power BI à l’aide de l'Obtenir des abonnements de rapport en tant qu’appel d’API d’administrateur.
users

ReportUser[]

(Valeur vide) Les détails de l’accès utilisateur à un rapport Power BI. Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations utilisateur sur un rapport Power BI à l’aide de l'Obtenir des utilisateurs de rapport en tant qu’appel d’API administrateur, ou de l’appel d’API PostWorkspaceInfo avec le paramètre getArtifactUsers.
webUrl

string

URL web du rapport

ReportUser

Object

Entrée de droit d’accès utilisateur Power BI pour un rapport

Nom Type Description
displayName

string

Nom complet du principal
emailAddress

string

Adresse e-mail de l’utilisateur
graphId

string

Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier

string

Identificateur du principal
principalType

PrincipalType

Type de principal
profile

ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
reportUserAccessRight

ReportUserAccessRight

Droit d’accès dont l’utilisateur dispose pour le rapport (niveau d’autorisation)
userType

string

Type de l’utilisateur.

ReportUserAccessRight

Énumération

Droit d’accès dont l’utilisateur dispose pour le rapport (niveau d’autorisation)

Valeur Description
None

Aucune autorisation pour le contenu dans le rapport
Owner

Accorde l’accès en lecture, écriture et partage à nouveau au contenu dans le rapport
Read

Octroie l’accès en lecture au contenu dans le rapport
ReadCopy

Octroie l’accès en lecture et copie au contenu dans le rapport
ReadReshare

Accorde l’accès en lecture et repartage au contenu dans le rapport
ReadWrite

Octroie l’accès en lecture et écriture au contenu dans le rapport

ServicePrincipalProfile

Object

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.

Nom Type Description
displayName

string

Nom du profil du principal de service
id

string (uuid)

ID de profil du principal de service

Subscription

Object

Un abonnement par e-mail pour un élément Power BI (tel qu’un rapport ou un tableau de bord)

Nom Type Description
artifactDisplayName

string

Nom de l’élément Power BI abonné (tel qu’un rapport ou un tableau de bord)
artifactId

string (uuid)

ID de l’élément Power BI abonné (tel qu’un rapport ou un tableau de bord)
artifactType

string

Type d’élément Power BI (par exemple, un Report, Dashboardou Dataset)
attachmentFormat

string

Format du rapport joint dans l’abonnement par e-mail
endDate

string (date-time)

Date et heure de fin de l’abonnement par e-mail
frequency

string

Fréquence de l’abonnement par e-mail
id

string (uuid)

ID d’abonnement
isEnabled

boolean

Indique si l’abonnement par e-mail est activé
linkToContent

boolean

Indique si un lien d’abonnement existe dans l’abonnement par e-mail
previewImage

boolean

Indique si une capture d’écran du rapport existe dans l’abonnement par e-mail
startDate

string (date-time)

Date et heure de début de l’abonnement par e-mail
subArtifactDisplayName

string

Nom de la page de l’élément Power BI abonné, s’il s’agit d’un rapport.
title

string

Nom de l’application
users

SubscriptionUser[]

Détails de chaque abonné à l’e-mail. Lorsque vous utilisez l'Obtenir des abonnements utilisateur en tant qu’appel d’API administrateur, la valeur retournée est un tableau vide (null). Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations d’abonnement sur un rapport Ou un tableau de bord Power BI à l’aide de l'Obtenir des abonnements de rapport en tant qu’administrateur ou Obtenir des abonnements de tableau de bord en tant qu’appels d’API d’administrateur.

SubscriptionUser

Object

Un utilisateur d’abonnement de messagerie Power BI

Nom Type Description
displayName

string

Nom complet du principal
emailAddress

string

Adresse e-mail de l’utilisateur
graphId

string

Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier

string

Identificateur du principal
principalType

PrincipalType

Type de principal
profile

ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType

string

Type de l’utilisateur.