Freigeben über

Items - Get Semantic Model Definition

Dienst:
SemanticModel
API-Version:
v1

Gibt die angegebene öffentliche Definition des semantischen Modells zurück.
Diese API unterstützt LRO-.

Wenn Sie die öffentliche Definition eines semantischen Modells erhalten, ist die Vertraulichkeitsbezeichnung nicht Teil der Definition.

Erlaubnisse

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

Erforderliche delegierte Bereiche

SemanticModel.ReadWrite.All oder Item.ReadWrite.All

Einschränkungen

Diese API wird für ein semantisches Modell mit einer verschlüsselten Vertraulichkeitsbezeichnung blockiert.

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}/getDefinition
Mit optionalen Parametern: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/getDefinition?format={format}

URI-Parameter

Name In Erforderlich Typ Beschreibung
semanticModelId
 path True

string (uuid)

Die Semantikmodell-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
format
 query

string

Das Format der Semantikmodelldefinition.

Die folgenden Formate sind zulässig (Groß-/Kleinschreibung wird beachtet)

    • TMDL
    • TMSL

Wenn nicht angegeben, lautet der Standardwert "TMDL".

Antworten

Name Typ Beschreibung
200 OK

SemanticModelDefinitionResponse

Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted

Anforderung angenommen. Das Abrufen der Definition wird ausgeführt.

Header

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

ErrorResponse

Häufige Fehlercodes:

  • OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.

Beispiele

Get a semantic model definition example

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
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.
SemanticModelDefinitionPart

Semantikmodelldefinitionsteilobjekt.
SemanticModelDefinitionResponse

Antwort auf öffentliche Definition des semantischen Modells.

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.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

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.
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.

Name Typ Beschreibung
format

string

Das Format der Elementdefinition.
parts

SemanticModelDefinitionPart[]

Eine Liste der Definitionsteile.

SemanticModelDefinitionPart

Objekt

Semantikmodelldefinitionsteilobjekt.

Name Typ Beschreibung
path

string

Der Semantikmodellteilpfad.
payload

string

Die Nutzlast des Semantikmodellteils.
payloadType

PayloadType

Der Nutzlasttyp.

SemanticModelDefinitionResponse

Objekt

Antwort auf öffentliche Definition des semantischen Modells.

Name Typ Beschreibung
definition

SemanticModelDefinition

öffentliche Definition des semantischen Modells Objekts.