Imports - Get Import
Retourne l’importation spécifiée à partir de Mon espace de travail.
Étendue requise
Dataset.ReadWrite.All ou Dataset.Read.All
GET https://api.powerbi.com/v1.0/myorg/imports/{importId}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
import
|
path | True |
string uuid |
ID d’importation |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
Exemples
Completed import example |
In-progress import example |
Completed import example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7
Sample Response
{
"id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
"importState": "Succeeded",
"createdDateTime": "2018-05-08T14:56:18.477Z",
"updatedDateTime": "2018-05-08T14:56:18.477Z",
"name": "SalesMarketing",
"connectionType": "import",
"source": "Upload",
"datasets": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
],
"reports": [
{
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/reports/5b218778-e7a5-4d73-8187-f10824047715",
"embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
}
]
}
In-progress import example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7
Sample Response
{
"id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
"importState": "Publishing",
"createdDateTime": "2018-05-08T14:56:18.477Z",
"updatedDateTime": "2018-05-08T14:56:18.477Z",
"name": "SalesMarketing",
"connectionType": "import",
"source": "Upload",
"datasets": [],
"reports": []
}
Définitions
Nom | Description |
---|---|
Dataset |
Un jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de 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. |
Dataset |
Paramètres de scale-out de requête d’un jeu de données |
Dataset |
Entrée de droit d’accès utilisateur Power BI pour un jeu de données |
Dataset |
Droit d’accès dont dispose l’utilisateur pour le jeu de données (niveau d’autorisation) |
Dependent |
Un flux de données dépendant de Power BI |
Encryption |
Informations de chiffrement pour un jeu de données |
Encryption |
status de chiffrement de jeu de données |
Import |
Objet import |
Principal |
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. |
Report |
Entrée de droit d’accès utilisateur Power BI pour un rapport |
Report |
Droit d’accès dont dispose l’utilisateur pour le rapport (niveau d’autorisation) |
Service |
Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire. |
Subscription |
Un abonnement par e-mail pour un élément Power BI (tel qu’un rapport ou un tableau de bord) |
Subscription |
Un utilisateur d’abonnement de messagerie Power BI |
Dataset
Un jeu de données Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de 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 |
Informations de chiffrement du jeu de données. Applicable uniquement lorsque |
|
IsEffectiveIdentityRequired |
boolean |
Indique si le jeu de données nécessite une identité efficace, que vous devez envoyer dans un appel d’API GenerateToken . |
IsEffectiveIdentityRolesRequired |
boolean |
Indique si la sécurité au niveau des lignes est définie dans le 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 est actualisable 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 |
URL incorporée du jeu de données Q&A |
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 |
Interroger les paramètres de scale-out d’un jeu de données |
|
targetStorageMode |
string |
Mode de stockage du jeu de données |
upstreamDataflows |
La liste de tous les flux de données dont dépend cet élément |
|
users |
(Valeur vide) Détails de l’accès 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 de l’API Get Dataset Users as Administration ou de l’API PostWorkspaceInfo avec le |
|
webUrl |
string |
URL web du jeu de données |
DatasetQueryScaleOutSettings
Paramètres de scale-out de requête 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 |
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 |
Type principal |
|
profile |
Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire. |
|
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 sur le 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 dans le jeu de données |
ReadReshare |
string |
Octroie l’accès en lecture et en partage au contenu dans le jeu de données |
ReadReshareExplore |
string |
Octroie l’accès en lecture, partage 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, partage 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 |
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 import
Nom | Type | Description |
---|---|---|
createdDateTime |
string |
Date et heure de création de l’importation |
datasets |
Dataset[] |
Jeux de données associés à cette importation |
id |
string |
ID d’importation |
importState |
enum:
|
État de chargement de l’importation |
name |
string |
Nom de l’importation |
reports |
Report[] |
Les rapports associés à cette importation |
updatedDateTime |
string |
Date et heure de la dernière mise à jour |
PrincipalType
Type principal
Nom | Type | Description |
---|---|---|
App |
string |
Type de principal de service |
Group |
string |
Type de principal de groupe |
None |
string |
Aucun type principal. Utilisez pour un accès de niveau organization entier. |
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 du jeu de données du rapport |
description |
string |
Description du rapport |
embedUrl |
string |
URL incorporée 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:
|
Type de rapport |
subscriptions |
(Valeur vide) Détails de l’abonnement pour un élément Power BI (par exemple, 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 les informations d’abonnement d’un rapport Power BI à l’aide de l’appel d’API Get Report Subscriptions as Administration. |
|
users |
(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 prochaine version. Vous pouvez récupérer des informations utilisateur sur 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 |
|
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 |
Type principal |
|
profile |
Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée. |
|
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 en 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. Ne concerne que Power BI Embedded solution multilocataire.
Nom | Type | Description |
---|---|---|
displayName |
string |
Nom du profil principal de service |
id |
string |
ID de profil du principal de service |
Subscription
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é (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 , |
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 |
Indique si l’abonnement par e-mail 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 la page de l’élément Power BI abonné, s’il s’agit d’un rapport. |
title |
string |
Nom de l’application |
users |
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 |
Type principal |
|
profile |
Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire. |
|
userType |
string |
Type de l’utilisateur. |