Admin - Reports GetReportsAsAdmin

Service:: Power BI REST APIs

Version de l’API:: v1.0

Retourne une liste de rapports pour l’organisation.

Autorisations

L’utilisateur doit être un administrateur Fabric ou s’authentifier à l’aide d’un principal de service.
Les autorisations déléguées sont prises en charge.

Lors de l’exécution sous l’authentification prinicipal du service, une application ne doit pas disposer de prémissions requises par l’administrateur pour Power BI définies sur celui-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 50 requêtes par heure ou 5 requêtes par minute, par locataire.

GET https://api.powerbi.com/v1.0/myorg/admin/reports

Avec paramètres optionnels:

GET https://api.powerbi.com/v1.0/myorg/admin/reports?$filter={$filter}&$top={$top}&$skip={$skip}

Paramètres d’URI

Nom	Dans	Type	Description
$filter	query	string	Retourne un sous-ensemble de résultats basés sur condition de paramètre de requête de filtre Odata.
$skip	query	integer (int32)	Ignore les premiers n résultats
$top	query	integer (int32)	Retourne uniquement les premiers n résultats

Réponses

Nom	Type	Description
200 OK	AdminReports	D’ACCORD

Exemples

Example

Demande d’échantillon

GET https://api.powerbi.com/v1.0/myorg/admin/reports

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "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",
      "workspaceId": "278e22a3-2aee-4057-886d-c3225423bc10"
    }
  ]
}

Définitions

Nom	Description
AdminReport	Rapport Power BI retourné par les API d’administration. 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.
AdminReports	Wrapper de réponse OData pour une collection de rapports d’administration Power BI
PrincipalType	Type de principal
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

AdminReport

Objet

Rapport Power BI retourné par les API d’administration. 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
createdBy	string	Propriétaire du rapport. Disponible uniquement pour les rapports créés après juin 2019.
createdDateTime	string (date-time)	Date et heure de création du rapport
datasetId	string	ID de jeu de données du rapport
description	string	Description du rapport
embedUrl	string	URL incorporée du rapport
format	string	Type de format de définition de rapport. Pour PowerBIReport : PBIR PBIR-Legacy Pour PaginédReport : `RDL`
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.
modifiedBy	string	Dernier utilisateur qui a modifié le rapport
modifiedDateTime	string (date-time)	Date et heure de la dernière modification du rapport
name	string	Nom du rapport. Les rapports d’application commencent par le préfixe [Application].
originalReportObjectId	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
workspaceId	string (uuid)	ID d’espace de travail (GUID) du rapport. Cette propriété est retournée uniquement dans GetReportsAsAdmin.

AdminReports

Objet

Wrapper de réponse OData pour une collection de rapports d’administration Power BI

Nom	Type	Description
@odata.context	string	Contexte OData
value	AdminReport[]	Collection de rapports

PrincipalType

Énumération

Type de principal

Valeur	Description
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
Group	Type de principal de groupe
App	Type de principal de service

ReportUser

Objet

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
Read	Octroie l’accès en lecture au contenu dans le rapport
ReadWrite	Octroie l’accès en lecture et écriture au contenu dans le rapport
ReadReshare	Accorde l’accès en lecture et repartage au contenu dans le rapport
ReadCopy	Octroie l’accès en lecture et copie au contenu dans le rapport
Owner	Accorde l’accès en lecture, écriture et partage à nouveau au contenu dans le rapport

ServicePrincipalProfile

Objet

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

Objet

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`, `Dashboard`ou `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

Objet

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.

Partager via

Admin - Reports GetReportsAsAdmin

Autorisations

Étendue requise

Limites

Paramètres d’URI

Réponses

Exemples

Example

Demande d’échantillon

Exemple de réponse

Définitions

AdminReport

AdminReports

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser