Admin - WorkspaceInfo PostWorkspaceInfo

Référence

Service:: Power BI REST APIs

API Version:: v1.0

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

Important

Si vous définissez les datasetSchema paramètres trueou datasetExpressions sur , 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.

Autorisations

L’utilisateur doit disposer de droits d’administrateur (par exemple, administrateur général Microsoft 365 ou administrateur de service Power BI) ou s’authentifier à l’aide d’un principal de service.

Lors de l’exécution sous l’authentification du principal de service, aucune autorisation d’administrateur requise pour Power BI ne doit être définie sur une application dans le Portail Azure.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Pertinent 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 500 demandes par heure.
Maximum 16 demandes simultanées.

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo

With optional parameters:

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	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 sur `true`, 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 sur `true`, 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 d’un élément Power BI (par exemple, un rapport ou un tableau de bord)
lineage	query	boolean	Indique s’il faut retourner les 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[]	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ée

Exemples

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True

Request Body

{
  "workspaces": [
    "97d03602-4873-4760-b37e-1563ef5358e3",
    "67b7e93a-3fb3-493c-9e41-2c5051008f24"
  ]
}

Sample Response

Status code:: 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’espaces de travail requis
ScanRequest	Une demande d’analyse

PowerBIApiErrorResponseDetail

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

Nom	Type	Description
code	string	Le code d'erreur
message	string	Message d'erreur.
target	string	Cible d’erreur

RequiredWorkspaces

Une demande d’espaces de travail requis

Nom	Type	Description
workspaces	string[]	ID d’espace de travail requis à analyser (prend en charge 1 à 100 ID d’espace de travail)

ScanRequest

Une demande d’analyse

Nom	Type	Description
createdDateTime	string	Date et heure de création de l’analyse
error	PowerBIApiErrorResponseDetail	Erreur d’analyse (le cas échéant)
id	string	ID d’analyse
status	string	État de l’analyse