Items - Get Semantic Model Definition

Service:

SemanticModel

Version d'API:

v1

Retourne la définition publique du modèle sémantique spécifié.
Cette API prend en charge opérations longues (LRO).

Lorsque vous obtenez la définition publique d’un modèle sémantique, 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 modèle sémantique.

Étendues déléguées requises

SemanticModel.ReadWrite.All ou Item.ReadWrite.All

Limites

Cette API est bloquée pour un modèle sémantique 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}/semanticModels/{semanticModelId}/getDefinition

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
semanticModelId	path	True	string (uuid)	ID de modèle sémantique.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
format	query		string	Format de la définition du modèle sémantique. Les formats suivants sont autorisés (respectant la casse) TMDL TMSL S’il n’est pas spécifié, la valeur par défaut est « TMDL ».

Réponses

Nom	Type	Description
200 OK	SemanticModelDefinitionResponse	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 semantic model definition example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

{
  "definition": {
    "parts": [
      {
        "path": "definition/database.tmdl",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition/model.tmdl",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition/tables/Table1.tmdl",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbism",
        "payload": "<base64 encoded string>",
        "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.
SemanticModelDefinition	définition publique du modèle sémantique objet.
SemanticModelDefinitionPart	Objet de partie de définition de modèle sémantique.
SemanticModelDefinitionResponse	Réponse de définition publique du modèle sémantique.

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.

SemanticModelDefinition

Object

définition publique du modèle sémantique objet.

Nom	Type	Description
format	string	Format de la définition d’élément.
parts	SemanticModelDefinitionPart[]	Liste des parties de définition.

SemanticModelDefinitionPart

Object

Objet de partie de définition de modèle sémantique.

Nom	Type	Description
path	string	Chemin de la partie du modèle sémantique.
payload	string	Charge utile de la partie du modèle sémantique.
payloadType	PayloadType	Type de charge utile.

SemanticModelDefinitionResponse

Object

Réponse de définition publique du modèle sémantique.

Nom	Type	Description
definition	SemanticModelDefinition	définition publique du modèle sémantique objet.