Partager via

Items - Get Report Definition

Service:
Report
Version d'API:
v1

Retourne la définition publique de rapport spécifiée.
Cette API prend en charge opérations longues (LRO).

Lorsque vous obtenez la définition publique d’un rapport, l’étiquette de confidentialité ne fait pas partie de la définition.

Autorisations

L’appelant doit disposer d’autorisations de lecture et d’écriture pour le rapport.

Étendues déléguées requises

Report.ReadWrite.All ou Item.ReadWrite.All

Limites

Cette API est bloquée pour un rapport avec une étiquette de confidentialité chiffrée.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
Service principal et identités gérées Oui

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/getDefinition

Paramètres URI

Nom Dans Obligatoire Type Description
reportId
 path True

string (uuid)

ID de rapport.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Réponses

Nom Type Description
200 OK

ReportDefinitionResponse

La demande s’est terminée avec succès.
202 Accepted

Demande acceptée. La récupération de la définition est en cours.

En-têtes

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • OperationNotSupportedForItem : opération non prise en charge pour l’élément demandé.

Exemples

Get a report definition example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/reports/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Exemple de réponse

Code d’état:
200 
{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Code d’état:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
PayloadType

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.
ReportDefinition

Objet de définition publique de rapport. Reportez-vous à cet article pour plus d’informations sur la création d’une définition publique de rapport.
ReportDefinitionPart

Objet de partie définition de rapport.
ReportDefinitionResponse

Signaler la réponse de définition publique.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
InlineBase64

Base 64 inline.

ReportDefinition

Object

Objet de définition publique de rapport. Reportez-vous à cet article pour plus d’informations sur la création d’une définition publique de rapport.

Nom Type Description
format

string

Format de la définition d’élément.
parts

ReportDefinitionPart[]

Liste des parties de définition.

ReportDefinitionPart

Object

Objet de partie définition de rapport.

Nom Type Description
path

string

Chemin d’accès de la partie rapport.
payload

string

Charge utile de la partie de rapport.
payloadType

PayloadType

Type de charge utile.

ReportDefinitionResponse

Object

Signaler la réponse de définition publique.

Nom Type Description
definition

ReportDefinition

Objet de définition publique de rapport. Reportez-vous à cet article pour plus d’informations sur la création d’une définition publique de rapport.