Items - Get Graph Model Definition

Servizio:: GraphModel

Versione API:: v1

Restituisce la definizione pubblica di GraphModel specificata.

Annotazioni

L'elemento GraphModel è attualmente disponibile in anteprima (altre informazioni).

Questa API supporta operazioni con esecuzione prolungata (LRO).

Quando si ottiene la definizione pubblica di GraphModel, l'etichetta di riservatezza non fa parte della definizione.

Permissions

Il chiamante deve disporre delle autorizzazioni di lettura e scrittura per GraphModel.

Ambiti delegati obbligatori

Elemento.LeggiScrivi.Tutto

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Yes
Principale del servizio e Identità gestite	NO

Interfaccia

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
GraphModelId	path	True	string (uuid)	ID GraphModel.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
format	query		string	Formato della definizione pubblica di GraphModel.

Risposte

Nome	Tipo	Descrizione
200 OK	GraphModelDefinitionResponse	Richiesta completata correttamente.
202 Accepted		Richiesta accettata. Il recupero della definizione è in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: OperationNotSupportedForItem: operazione non supportata per l'elemento richiesto.

Esempio

Get a GraphModel public definition example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
      }
    ]
  }
}

Codice di stato:: 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

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
GraphModelDefinitionFormat	Formato della definizione dell'elemento. È possibile aggiungere altri tipi di `format` nel tempo.
GraphModelDefinitionResponse	Risposta alla definizione pubblica di GraphModel.
GraphModelPublicDefinition	Oggetto definizione pubblica GraphModel. Per altre informazioni su come creare una definizione pubblica di GraphModel, vedere questo articolo .
GraphModelPublicDefinitionPart	Oggetto parte di definizione GraphModel.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

GraphModelDefinitionFormat

Enumerazione

Formato della definizione dell'elemento. È possibile aggiungere altri tipi di format nel tempo.

Valore	Descrizione
json	Formato JSON per la definizione pubblica graphModel, progettato in modo specifico per supportare scenari CI/CD in Fabric.

GraphModelDefinitionResponse

Oggetto

Risposta alla definizione pubblica di GraphModel.

Nome	Tipo	Descrizione
definition	GraphModelPublicDefinition	Oggetto definizione pubblica GraphModel. Per altre informazioni su come creare una definizione pubblica di GraphModel, vedere questo articolo .

GraphModelPublicDefinition

Oggetto

Oggetto definizione pubblica GraphModel. Per altre informazioni su come creare una definizione pubblica di GraphModel, vedere questo articolo .

Nome	Tipo	Descrizione
format	GraphModelDefinitionFormat	Formato della definizione dell'elemento. È possibile aggiungere altri tipi di `format` nel tempo.
parts	GraphModelPublicDefinitionPart[]	Elenco di parti di definizione.

GraphModelPublicDefinitionPart

Oggetto

Oggetto parte di definizione GraphModel.

Nome	Tipo	Descrizione
path	string	Percorso della parte della definizione pubblica GraphModel.
payload	string	Payload della parte di definizione pubblica GraphModel.
payloadType	PayloadType	Tipo di payload.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

Condividi tramite

Items - Get Graph Model Definition

Permissions

Ambiti delegati obbligatori

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Risposte

Esempio

Get a GraphModel public definition example

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModelDefinitionFormat

GraphModelDefinitionResponse

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

PayloadType