Imports - Post Import In Group

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

Crée du contenu dans l’espace de travail spécifié.

Notes

Contenu pris en charge :

  • Fichiers .pbix Power BI
  • Fichiers JSON (.json)
  • Fichiers Excel (.xlsx)
  • SQL Server 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 demande.
  • Pour importer un fichier .rdl, incluez l’extension de fichier dans le nom spécifié par datasetDisplayName, comme décrit dans Paramètres d’URI.
  • 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 demande.
  • Pour importer des fichiers .pbix Power BI volumineux dont la taille est comprise entre 1 Go et 10 Go, consultez Create emplacement de chargement temporaire dans le groupe et le script PowerShell Importer des fichiers volumineux. Cela est pris en charge uniquement pour les espaces de travail de capacité Premium.
  • Pour créer un flux de données à partir d’un fichier model.json, définissez datasetDisplayNamesur model.json, comme décrit dans Paramètres d’URI.

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

Dataset.ReadWrite.All

Limites

  • Les flux de données avec le 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 étiquette de confidentialité protégée n’est pas prise en charge pour les principaux de service. 

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

Paramètres URI

Nom Dans Obligatoire Type Description
groupId
 path True

string

uuid

L’ID de l’espace de travail
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. Pour importer ou créer des flux de données, ce paramètre doit être codé en dur pour model.json.
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. Pour les fichiers de flux de données model.json et AbortGenerateUniqueName sont les seules options prises en charge.
overrideModelLabel
 query

boolean

Détermine s’il faut remplacer l’étiquette existante sur un modèle lors de la republication 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 existante sur un rapport lors de la republication 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. S'il est spécifié, la valeur doit être true. Pris en charge uniquement pour les fichiers .pbix Power BI.
subfolderObjectId
 query

string

uuid

ID de sous-dossier pour importer le fichier dans le sous-dossier.

Corps de la demande

Media Types: "application/json", "multipart/form-data"

Nom Type Description
connectionType

connectionType

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

string

Chemin du OneDrive Entreprise fichier Excel (.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 .pbix Power BI volumineux d’une taille comprise entre 1 Go et 10 Go.

Réponses

Nom Type Description
200 OK

Import

Ok
202 Accepted

Import

Accepté

Exemples

Import dataflow model.json example
Post import example
Post import skip report example

Import dataflow model.json example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True
Request Body
{
  "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--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import skip report example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Définitions

Nom Description
connectionType

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

Jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés du jeu de données. Le sous-ensemble dépend de l’API appelée, des autorisations de l’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 dont dispose l’utilisateur pour le jeu de données (niveau d’autorisation)
DependentDataflow

Un flux de données dépendant de Power BI
Encryption

Informations de chiffrement pour un jeu de données
EncryptionStatus

status de chiffrement de jeu de données
Import

Objet d’importation
ImportConflictHandlerMode

Spécifie la procédure à suivre 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. Pour le flux de données, Abort model.json fichiers et GenerateUniqueName sont les seules options prises en charge.
ImportInfo

Informations sur l’importation
PrincipalType

Type principal
Report

Un 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 de l’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 dispose l’utilisateur pour le rapport (niveau d’autorisation)
ServicePrincipalProfile

Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
Subscription

Un abonnement de messagerie 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

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

Nom Type Description
connect

string

import

string

Dataset

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

Nom Type Description
ContentProviderType

string

Type de fournisseur de contenu pour le jeu de données
CreateReportEmbedURL

string

URL d’incorporation du jeu de données de création de rapport
CreatedDate

string

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

Encryption

Informations de chiffrement de 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. Si c’est le cas, vous devez spécifier un rôle.
IsInPlaceSharingEnabled

boolean

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

Indique si le jeu de données peut être actualisé ou non. Un jeu de données actualisable Power BI est un jeu de données qui a été actualisé au moins une fois ou pour lequel une planification d’actualisation valide existe.
QnaEmbedURL

string

L’URL incorporée Q&A du jeu de données
addRowsAPIEnabled

boolean

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

string

Propriétaire 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
queryScaleOutSettings

DatasetQueryScaleOutSettings

Paramètres de scale-out de requête 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 version à venir. 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 de l’API Get Dataset Users as Administration ou de l’API PostWorkspaceInfo avec le getArtifactUsers paramètre .
webUrl

string

URL web du jeu de données

DatasetQueryScaleOutSettings

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

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

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 dont dispose l’utilisateur pour le jeu de données (niveau d’autorisation)
displayName

string

Nom d’affichage 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 principal
profile

ServicePrincipalProfile

Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
userType

string

Type de l’utilisateur.

DatasetUserAccessRight

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

Nom Type Description
None

string

Supprime l’autorisation d’accès au contenu dans le jeu de données
Read

string

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

string

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

string

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

string

Octroie l’accès en lecture, repartage et exploration au contenu du jeu de données
ReadWrite

string

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

string

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

string

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

string

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

DependentDataflow

Un flux de données dépendant de Power BI

Nom Type Description
groupId

string

ID du groupe cible
targetDataflowId

string

ID de flux de données cible

Encryption

Informations de chiffrement pour un jeu de données

Nom Type Description
EncryptionStatus

EncryptionStatus

status de chiffrement de jeu de données

EncryptionStatus

status de chiffrement de jeu de données

Nom Type Description
InSyncWithWorkspace

string

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

string

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

string

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

string

Le status de chiffrement est inconnu en raison d’une altération du jeu de données

Import

Objet d’importation

Nom Type Description
createdDateTime

string

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

Dataset[]

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

string

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 et heure de la dernière mise à jour

ImportConflictHandlerMode

Spécifie la procédure à suivre 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. Pour le flux de données, Abort model.json fichiers et GenerateUniqueName sont les seules options prises en charge.

Nom Type Description
Abort

string

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

string

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 portant le même nom.
GenerateUniqueName

string

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 flux de données.
Ignore

string

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

string

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 portant le même nom.

ImportInfo

Informations sur l’importation

Nom Type Description
connectionType

connectionType

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

string

Chemin d’accès du OneDrive Entreprise fichier Excel (.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 d’une taille comprise entre 1 Go et 10 Go.

PrincipalType

Type principal

Nom Type Description
App

string

Type de principal de service
Group

string

Type de principal de groupe
None

string

Aucun type de principal. Utilisez pour un accès entier organization niveau.
User

string

Type de principal d’utilisateur

Report

Un 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 de l’appelant et de la disponibilité des données dans la base de données Power BI.

Nom Type Description
appId

string

ID d’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 d’incorporation du rapport
id

string

ID de rapport
isOwnedByMe

boolean

Déterminez si le rapport est créé par l’utilisateur actuel.
name

string

Nom du rapport
originalReportId

string

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 version à venir. Vous pouvez récupérer des informations d’abonnement pour un rapport Power BI à l’aide de l’option Obtenir des abonnements de rapport en tant qu’appel d’API Administration.
users

ReportUser[]

(Valeur vide) Détails d’accès utilisateur pour un rapport Power BI. Cette propriété sera supprimée de la réponse de charge utile dans une version à venir. Vous pouvez récupérer les informations utilisateur d’un rapport Power BI à l’aide de l’appel d’API Get Report Users as Administration, ou de l’appel d’API PostWorkspaceInfo avec le getArtifactUsers paramètre .
webUrl

string

URL web du rapport

ReportUser

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

Nom Type Description
displayName

string

Nom d’affichage 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 principal
profile

ServicePrincipalProfile

Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
reportUserAccessRight

ReportUserAccessRight

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

string

Type de l’utilisateur.

ReportUserAccessRight

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

Nom Type Description
None

string

Aucune autorisation d’accès au contenu dans le rapport
Owner

string

Octroie l’accès en lecture, écriture et repartage au contenu du rapport
Read

string

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

string

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

string

Octroie l’accès en lecture et repartage au contenu du rapport
ReadWrite

string

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

ServicePrincipalProfile

Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.

Nom Type Description
displayName

string

Nom du profil de principal de service
id

string

ID de profil du principal de service

Subscription

Un abonnement de messagerie 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é (par exemple, un rapport ou un tableau de bord)
artifactId

string

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 Report, Dashboardou Dataset)
attachmentFormat

string

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

string

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

string

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

string

ID d’abonnement
isEnabled

boolean

Si l’abonnement de messagerie est activé
linkToContent

boolean

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

boolean

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

string

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

string

Nom de 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. Lors de l’utilisation de l’appel d’API Get User Subscriptions As Administration, 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 des appels d’API Obtenir des abonnements aux rapports en tant que Administration ou Obtenir des abonnements au tableau de bord en tant que Administration.

SubscriptionUser

Un utilisateur d’abonnement de messagerie Power BI

Nom Type Description
displayName

string

Nom d’affichage 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 principal
profile

ServicePrincipalProfile

Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
userType

string

Type de l’utilisateur.