Items - Update Semantic Model Definition

Service:: SemanticModel

Version d’API:: v1

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

La mise à jour de la définition du modèle sémantique n’affecte pas son étiquette de confidentialité.

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

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}/updateDefinition

Avec des paramètres facultatifs:

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

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.
updateMetadata	query		boolean	Lorsque la valeur est true et que le fichier .platform est fourni dans le cadre de la définition, les métadonnées de l’élément sont mises à jour à l’aide des métadonnées dans le fichier .platform

Corps de la demande

Nom	Obligatoire	Type	Description
definition	True	SemanticModelDefinition	définition publique du modèle sémantique objet. Pour plus d’informations sur la structure de la définition du modèle sémantique, consultez cet article .
options		SemanticModelDefinitionOptions	Options pour le modèle sémantique dont la définition est mise à jour.

Réponses

Nom	Type	Description
200 OK		La demande s’est terminée avec succès.
202 Accepted		Demande acceptée. La définition de mise à jour 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é. CorruptedPayload : la charge utile fournie est endommagée.

Exemples

Update a semantic model definition example

Exemple de requête

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "model.bim",
        "payload": "ewogICJjb21wYXRpYmlsaXR5TGV2ZW..GVzIjogWyBdDQogIH0NCn0",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbism",
        "payload": "ewogICJ2ZXJzaW9uIjogIjQuMC..HRpbmdzIjoge30KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 200

Code d’état:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Définitions

Nom	Description
ErrorParameter	Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.
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. Pour plus d’informations sur la structure de la définition du modèle sémantique, consultez cet article .
SemanticModelDefinitionOptions	Options qui s’appliquent lors de la création d’un modèle sémantique avec une définition ou de la mise à jour de la définition d’un modèle sémantique.
SemanticModelDefinitionPart	Objet de partie de définition de modèle sémantique.
UpdateSemanticModelDefinitionRequest	Mettre à jour la charge utile de demande de définition publique du modèle sémantique.

ErrorParameter

Objet

Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.

Nom	Type	Description
message	string	Description lisible par l’homme de la signification du paramètre.
name	string	L’identifiant de paramètre.
value	string	Représente la valeur du paramètre.

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.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
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.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur 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

Objet

définition publique du modèle sémantique objet. Pour plus d’informations sur la structure de la définition du modèle sémantique, consultez cet article .

Nom	Type	Description
format	string	Format de la définition du modèle sémantique.
parts	SemanticModelDefinitionPart[]	Liste des parties de définition.

SemanticModelDefinitionOptions

Objet

Options qui s’appliquent lors de la création d’un modèle sémantique avec une définition ou de la mise à jour de la définition d’un modèle sémantique.

Nom	Type	Description
allowPurgeData	boolean	Indique s’il faut autoriser la purge des données existantes du modèle sémantique lors de l’application de la définition mise à jour. Certaines modifications de définition nécessitent l’effacement des données existantes ; définissez cette valeur sur true pour permettre à ces modifications de continuer, auquel cas toutes les données qui ne peuvent pas être conservées dans la nouvelle définition sont vidées. Une fois l’opération terminée, actualisez le modèle sémantique pour recharger les données. La valeur par défaut est false.

SemanticModelDefinitionPart

Objet

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.

UpdateSemanticModelDefinitionRequest

Objet

Mettre à jour la charge utile de demande de définition publique du modèle sémantique.

Nom	Type	Description
definition	SemanticModelDefinition	définition publique du modèle sémantique objet. Pour plus d’informations sur la structure de la définition du modèle sémantique, consultez cet article .
options	SemanticModelDefinitionOptions	Options pour le modèle sémantique dont la définition est mise à jour.