Items - Get Graph Model Definition

Service:: GraphModel

API-versie:: v1

Retourneert de opgegeven openbare graphModel-definitie.

Opmerking

GraphModel-item is momenteel in preview (meer informatie).

Deze API ondersteunt langlopende bewerkingen (LRO).

Wanneer u de openbare definitie van GraphModel krijgt, maakt het vertrouwelijkheidslabel geen deel uit van de definitie.

Permissions

De aanroeper moet lees- en schrijfmachtigingen hebben voor het GraphModel.

Vereiste gedelegeerde bereiken

Item.ReadWrite.All

Limitations

Als u de definitie van een grafiekmodelitem wilt ophalen dat wordt beveiligd door een versleuteld vertrouwelijkheidslabel, moet de aanroeper over voldoende gebruiksrechten beschikken om het label te verwijderen, zoals geconfigureerd in Microsoft Purview.

Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Support
User	Yes
serviceprincipal en beheerde identiteiten	Yes

gebruikersinterface

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

Met optionele parameters:

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

URI-parameters

Naam	In	Vereist	Type	Description
graphModelId	path	True	string (uuid)	De GraphModel-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
format	query		string	De indeling van de openbare definitie van GraphModel.

Antwoorden

Naam	Type	Description
200 OK	GraphModelDefinitionResponse	De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd. Het ophalen van de definitie wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: OperationNotSupportedForItem - Bewerking wordt niet ondersteund voor aangevraagd item.

Voorbeelden

Get a GraphModel public definition example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Naam	Description
ErrorParameter	Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GraphModelDefinitionFormat	De indeling van de grafiekmodeldefinitie. Er kunnen in de loop van de tijd extra `format` typen worden toegevoegd.
GraphModelDefinitionResponse	Antwoord van openbare definitie van GraphModel.
GraphModelPublicDefinition	GraphModel public definition object. Raadpleeg dit artikel voor meer informatie over de structuur van de GraphModel-definitie.
GraphModelPublicDefinitionPart	GraphModel definition part object.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam	Type	Description
message	string	Een door mensen leesbare beschrijving van de betekenis van de parameter.
name	string	De parameter-id.
value	string	De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GraphModelDefinitionFormat

Opsomming

De indeling van de grafiekmodeldefinitie. Er kunnen in de loop van de tijd extra format typen worden toegevoegd.

Waarde	Description
json	JSON-indeling voor de openbare definitie van GraphModel, speciaal ontworpen ter ondersteuning van CI/CD-scenario's in Fabric.

GraphModelDefinitionResponse

Object

Antwoord van openbare definitie van GraphModel.

Naam	Type	Description
definition	GraphModelPublicDefinition	GraphModel public definition object. Raadpleeg dit artikel voor meer informatie over de structuur van de GraphModel-definitie.

GraphModelPublicDefinition

Object

GraphModel public definition object. Raadpleeg dit artikel voor meer informatie over de structuur van de GraphModel-definitie.

Naam	Type	Description
format	GraphModelDefinitionFormat	De indeling van de grafiekmodeldefinitie. Er kunnen in de loop van de tijd extra `format` typen worden toegevoegd.
parts	GraphModelPublicDefinitionPart[]	Een lijst met definitieonderdelen.

GraphModelPublicDefinitionPart

Object

GraphModel definition part object.

Naam	Type	Description
path	string	Het pad van het onderdeel openbare definitie van GraphModel.
payload	string	De nettolading van het openbare definitieonderdeel GraphModel.
payloadType	PayloadType	Het nettoladingstype.

PayloadType

Opsomming

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.