Items - Get Graph Model Definition

Dienst:: GraphModel

API-Version:: v1

Gibt die angegebene öffentliche GraphModel-Definition zurück.

Hinweis

Das GraphModel-Element befindet sich derzeit in der Vorschau (weitere Informationen).

Diese API unterstützt LRO-.

Wenn Sie die öffentliche Definition eines GraphModels erhalten, ist die Vertraulichkeitsbezeichnung kein Bestandteil der Definition.

Erlaubnisse

Der Aufrufer muss Über Lese- und Schreibberechtigungen für das GraphModel verfügen.

Erforderliche delegierte Bereiche

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	Support
Benutzer	Yes
Service Principal und Verwaltete Identitäten	Nein

Schnittstelle

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphModels/{GraphModelId}/getDefinition

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
GraphModelId	path	True	string (uuid)	Die GraphModel-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
format	query		string	Das Format der öffentlichen GraphModel-Definition.

Antworten

Name	Typ	Beschreibung
200 OK	GraphModelDefinitionResponse	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
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.

Beispiele

Get a GraphModel public definition example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

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.
GraphModelDefinitionFormat	Das Format der Elementdefinition. Zusätzliche `format` Typen können im Laufe der Zeit hinzugefügt werden.
GraphModelDefinitionResponse	Antwort auf öffentliche GraphModel-Definition.
GraphModelPublicDefinition	Öffentliches GraphModel-Definitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen GraphModel-Definition finden Sie in diesem Artikel .
GraphModelPublicDefinitionPart	GraphModel-Definitionsteilobjekt.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

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 (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.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GraphModelDefinitionFormat

Enumeration

Das Format der Elementdefinition. Zusätzliche format Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
json	JSON-Format für die öffentliche GraphModel-Definition, speziell für die Unterstützung von CI/CD-Szenarien in Fabric entwickelt.

GraphModelDefinitionResponse

Objekt

Antwort auf öffentliche GraphModel-Definition.

Name	Typ	Beschreibung
definition	GraphModelPublicDefinition	Öffentliches GraphModel-Definitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen GraphModel-Definition finden Sie in diesem Artikel .

GraphModelPublicDefinition

Objekt

Öffentliches GraphModel-Definitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen GraphModel-Definition finden Sie in diesem Artikel .

Name	Typ	Beschreibung
format	GraphModelDefinitionFormat	Das Format der Elementdefinition. Zusätzliche `format` Typen können im Laufe der Zeit hinzugefügt werden.
parts	GraphModelPublicDefinitionPart[]	Eine Liste der Definitionsteile.

GraphModelPublicDefinitionPart

Objekt

GraphModel-Definitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Pfad des öffentlichen GraphModel-Definitionsteils.
payload	string	Die Nutzlast des öffentlichen GraphModel-Definitionsteils.
payloadType	PayloadType	Der Nutzlasttyp.

PayloadType

Enumeration

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

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

Freigeben über

Items - Get Graph Model Definition

Erlaubnisse

Erforderliche delegierte Bereiche

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Antworten

Beispiele

Get a GraphModel public definition example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModelDefinitionFormat

GraphModelDefinitionResponse

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

PayloadType