Partager via

Admin - WorkspaceInfo PostWorkspaceInfo

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

Lance un appel pour recevoir des métadonnées pour la liste demandée des espaces de travail.

Important

Si vous définissez le ou datasetExpressions les paramètres truesur , vous devez activer entièrement l’analyse datasetSchema des métadonnées pour que les données soient retournées. Pour plus d’informations, consultez Activer les paramètres de locataire pour l’analyse des métadonnées.

Permissions

L’utilisateur doit être un administrateur Fabric ou s’authentifier à l’aide d’un principal de service.

Lors de l’exécution sous l’authentification du principal de service, une application ne doit pas disposer d’autorisations requises par l’administrateur pour Power BI définie sur celle-ci dans le portail Azure.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Applicable uniquement lors de l’authentification via un jeton d’accès administrateur délégué standard. Ne doit pas être présent lorsque l’authentification via un principal de service est utilisée.

Limites

  • Maximum de 500 requêtes par heure.
  • Maximum 16 requêtes simultanées. 

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo
Avec des paramètres facultatifs: 
POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}&datasetSchema={datasetSchema}&datasetExpressions={datasetExpressions}&getArtifactUsers={getArtifactUsers}

Paramètres URI

Nom Dans Obligatoire Type Description
datasetExpressions
 query

boolean

Indique s’il faut retourner des expressions de jeu de données (requêtes DAX et Mashup). Si vous définissez ce paramètre truesur , vous devez activer entièrement l’analyse des métadonnées pour que les données soient retournées. Pour plus d’informations, consultez Activer les paramètres de locataire pour l’analyse des métadonnées.
datasetSchema
 query

boolean

Indique s’il faut retourner le schéma du jeu de données (tables, colonnes et mesures). Si vous définissez ce paramètre truesur , vous devez activer entièrement l’analyse des métadonnées pour que les données soient retournées. Pour plus d’informations, consultez Activer les paramètres de locataire pour l’analyse des métadonnées.
datasourceDetails
 query

boolean

Indique s’il faut retourner les détails de la source de données
getArtifactUsers
 query

boolean

Indique s’il faut retourner les détails utilisateur pour un élément Power BI (tel qu’un rapport ou un tableau de bord)
lineage
 query

boolean

Indique s’il faut retourner des informations de traçabilité (flux de données en amont, vignettes, ID de source de données)

Corps de la demande

Nom Type Description
workspaces

string[] (uuid)

ID d’espace de travail requis à analyser (prend en charge 1 à 100 ID d’espace de travail)

Réponses

Nom Type Description
202 Accepted

ScanRequest

Accepté

Exemples

Example

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True
Corps de la demande
{
  "workspaces": [
    "97d03602-4873-4760-b37e-1563ef5358e3",
    "67b7e93a-3fb3-493c-9e41-2c5051008f24"
  ]
}

Exemple de réponse

Code d’état:
202 
{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "NotStarted"
}

Définitions

Nom Description
PowerBIApiErrorResponseDetail

Informations détaillées sur une réponse d’erreur Power BI
RequiredWorkspaces

Une demande d’espace de travail requise
ScanRequest

Une demande d’analyse

PowerBIApiErrorResponseDetail

Object

Informations détaillées sur une réponse d’erreur Power BI

Nom Type Description
code

string

Code d’erreur
message

string

Message d’erreur
target

string

Cible d’erreur

RequiredWorkspaces

Object

Une demande d’espace de travail requise

Nom Type Description
workspaces

string[] (uuid)

ID d’espace de travail requis à analyser (prend en charge 1 à 100 ID d’espace de travail)

ScanRequest

Object

Une demande d’analyse

Nom Type Description
createdDateTime

string (date-time)

Date et heure de création de l’analyse
error

PowerBIApiErrorResponseDetail

Erreur d’analyse (le cas échéant)
id

string (uuid)

ID d’analyse
status

string

État d’analyse