Items - Update Semantic Model Definition

Dienst:: SemanticModel

API-Version:: v1

Überschreibt die Definition für das angegebene Semantikmodell.
Diese API unterstützt LRO-.

Das Aktualisieren der Definition des Semantikmodells wirkt sich nicht auf die Vertraulichkeitsbezeichnung aus.

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für das semantische Modell besitzen.

Erforderliche delegierte Bereiche

SemanticModel.ReadWrite.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützung
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Schnittstelle

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
semanticModelId	path	True	string (uuid)	Die Semantikmodell-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
updateMetadata	query		boolean	Wenn sie auf "true" festgelegt ist und die PLATTFORM-Datei als Teil der Definition bereitgestellt wird, werden die Metadaten des Elements mithilfe der Metadaten in der PLATTFORM-Datei aktualisiert.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
definition	True	SemanticModelDefinition	öffentliche Definition des semantischen Modells Objekts. Weitere Informationen zur Struktur der Definition des semantischen Modells finden Sie in diesem Artikel .
options		SemanticModelDefinitionOptions	Optionen für das semantische Modell, dessen Definition aktualisiert wird.

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted		Anforderung angenommen. Die Updatedefinition wird ausgeführt. Header Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt. CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Update a semantic model definition example

Beispielanforderung

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"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

Statuscode:: 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

Definitionen

Name	Beschreibung
ErrorParameter	Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
SemanticModelDefinition	öffentliche Definition des semantischen Modells Objekts. Weitere Informationen zur Struktur der Definition des semantischen Modells finden Sie in diesem Artikel .
SemanticModelDefinitionOptions	Optionen, die beim Erstellen eines semantischen Modells mit einer Definition oder beim Aktualisieren der Definition eines Semantikmodells gelten.
SemanticModelDefinitionPart	Semantikmodelldefinitionsteilobjekt.
UpdateSemanticModelDefinitionRequest	Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung für das semantische Modell.

ErrorParameter

Objekt

Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.

Name	Typ	Beschreibung
message	string	Eine lesbare Beschreibung der Bedeutung des Parameters.
name	string	Die Parameterkennung.
value	string	Der übergebene Wert

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

SemanticModelDefinition

Objekt

öffentliche Definition des semantischen Modells Objekts. Weitere Informationen zur Struktur der Definition des semantischen Modells finden Sie in diesem Artikel .

Name	Typ	Beschreibung
format	string	Das Format der Semantikmodelldefinition.
parts	SemanticModelDefinitionPart[]	Eine Liste der Definitionsteile.

SemanticModelDefinitionOptions

Objekt

Optionen, die beim Erstellen eines semantischen Modells mit einer Definition oder beim Aktualisieren der Definition eines Semantikmodells gelten.

Name	Typ	Beschreibung
allowPurgeData	boolean	Gibt an, ob beim Anwenden der aktualisierten Definition das Löschen der vorhandenen Daten des Semantikmodells zulässig ist. Bei einigen Definitionsänderungen müssen vorhandene Daten gelöscht werden; legen Sie diesen Wert auf "true" fest, damit diese Änderungen fortgesetzt werden können. In diesem Fall werden alle Daten, die nicht unter der neuen Definition aufbewahrt werden können, gelöscht. Aktualisieren Sie nach Abschluss des Vorgangs das semantische Modell, um die Daten neu zu laden. Der Standardwert ist „false“.

SemanticModelDefinitionPart

Objekt

Semantikmodelldefinitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Semantikmodellteilpfad.
payload	string	Die Nutzlast des Semantikmodellteils.
payloadType	PayloadType	Der Nutzlasttyp.

UpdateSemanticModelDefinitionRequest

Objekt

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung für das semantische Modell.

Name	Typ	Beschreibung
definition	SemanticModelDefinition	öffentliche Definition des semantischen Modells Objekts. Weitere Informationen zur Struktur der Definition des semantischen Modells finden Sie in diesem Artikel .
options	SemanticModelDefinitionOptions	Optionen für das semantische Modell, dessen Definition aktualisiert wird.