Items - Get Graph Model Definition

Tjänst:

GraphModel

API-version:

v1

Returnerar den angivna offentliga GraphModel-definitionen.

Anmärkning

GraphModel-objektet finns för närvarande i förhandsversion (läs mer).

Det här API:et stöder tidskrävande åtgärder (LRO).

När du får en Offentlig definition för GraphModel är känslighetsetiketten inte en del av definitionen.

Permissions

Anroparen måste ha läs- och skrivbehörighet för GraphModel.

Obligatoriska delegerade omfång

Item.ReadWrite.All

Microsoft Entra identiteter som stöds

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Gränssnitt

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
graphModelId	path	True	string (uuid)	GraphModel-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.
format	query		string	Formatet för den offentliga GraphModel-definitionen.

Svar

Name	Typ	Description
200 OK	GraphModelDefinitionResponse	Begäran har slutförts.
202 Accepted		Begäran har godkänts. Hämtning av definitionen pågår. Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: OperationNotSupportedForItem – Åtgärden stöds inte för det begärda objektet.

Exempel

Get a GraphModel public definition example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GraphModelDefinitionFormat	Formatet för objektdefinitionen. Ytterligare format typer kan läggas till över tid.
GraphModelDefinitionResponse	GraphModels svar på offentlig definition.
GraphModelPublicDefinition	GraphModel-objekt för offentlig definition. Mer information om strukturen för GraphModel-definitionen finns i den här artikeln .
GraphModelPublicDefinitionPart	GraphModel-definitionsdelsobjekt.
PayloadType	Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GraphModelDefinitionFormat

Uppräkning

Formatet för objektdefinitionen. Ytterligare format typer kan läggas till över tid.

Värde	Description
json	JSON-format för den offentliga GraphModel-definitionen, särskilt utformat för att stödja CI/CD-scenarier i Fabric.

GraphModelDefinitionResponse

Objekt

GraphModels svar på offentlig definition.

Name	Typ	Description
definition	GraphModelPublicDefinition	GraphModel-objekt för offentlig definition. Mer information om strukturen för GraphModel-definitionen finns i den här artikeln .

GraphModelPublicDefinition

Objekt

GraphModel-objekt för offentlig definition. Mer information om strukturen för GraphModel-definitionen finns i den här artikeln .

Name	Typ	Description
format	GraphModelDefinitionFormat	Formatet för objektdefinitionen. Ytterligare format typer kan läggas till över tid.
parts	GraphModelPublicDefinitionPart[]	En lista över definitionsdelar.

GraphModelPublicDefinitionPart

Objekt

GraphModel-definitionsdelsobjekt.

Name	Typ	Description
path	string	Sökvägen till den offentliga definitionsdelen GraphModel.
payload	string	Nyttolasten för den offentliga definitionsdelen GraphModel.
payloadType	PayloadType	Nyttolasttypen.

PayloadType

Uppräkning

Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

Värde	Description
InlineBase64	Infogad bas 64.