Items - Get Graph Model Definition

Service:: GraphModel

Version d'API:: v1

Retourne la définition publique GraphModel spécifiée.

Note

L’élément GraphModel est actuellement en préversion (en savoir plus).

Cette API prend en charge opérations longues (LRO).

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

Permissions

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

Étendues déléguées requises

Item.ReadWrite.All

Microsoft Entra identités prises en charge

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

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

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition

Avec des paramètres facultatifs:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition?format={format}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
graphModelId	path	True	string (uuid)	ID GraphModel.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
format	query		string	Format de la définition publique GraphModel.

Réponses

Nom	Type	Description
200 OK	GraphModelDefinitionResponse	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
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes 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 GraphModel public definition example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "graphType.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "graphDefinition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dataSources.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "stylingConfiguration.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "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.
GraphModelDefinitionFormat	Format de la définition d’élément. Des types `format` supplémentaires peuvent être ajoutés au fil du temps.
GraphModelDefinitionResponse	Réponse de définition publique GraphModel.
GraphModelPublicDefinition	Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article .
GraphModelPublicDefinitionPart	Objet de partie de définition GraphModel.
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.

ErrorRelatedResource

Objet

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

Objet

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 (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

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.

GraphModelDefinitionFormat

Énumération

Format de la définition d’élément. Des types format supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
json	Format JSON pour la définition publique GraphModel, spécifiquement conçu pour prendre en charge les scénarios CI/CD dans Fabric.

GraphModelDefinitionResponse

Objet

Réponse de définition publique GraphModel.

Nom	Type	Description
definition	GraphModelPublicDefinition	Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article .

GraphModelPublicDefinition

Objet

Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article .

Nom	Type	Description
format	GraphModelDefinitionFormat	Format de la définition d’élément. Des types `format` supplémentaires peuvent être ajoutés au fil du temps.
parts	GraphModelPublicDefinitionPart[]	Liste des parties de définition.

GraphModelPublicDefinitionPart

Objet

Objet de partie de définition GraphModel.

Nom	Type	Description
path	string	Chemin du composant de définition publique GraphModel.
payload	string	Charge utile du composant de définition publique GraphModel.
payloadType	PayloadType	Type de charge utile.

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.

Partager via

Items - Get Graph Model Definition

Permissions

Étendues déléguées requises

Microsoft Entra identités prises en charge

Interface

Paramètres URI

Réponses

Exemples

Get a GraphModel public definition example

Exemple de requête

Exemple de réponse

Définitions

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModelDefinitionFormat

GraphModelDefinitionResponse

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

PayloadType