Items - Get Graph Model Definition

Serviço:: GraphModel

Versão da API:: v1

Retorna a definição pública do GraphModel especificada.

Observação

O item GraphModel está atualmente em versão prévia (saiba mais).

Essa API dá suporte a LRO (operações de execução longa).

Quando você obtém uma definição pública do GraphModel, o rótulo de confidencialidade não faz parte da definição.

Permissions

O chamador deve ter permissões de leitura e gravação para o GraphModel.

Escopos delegados necessários

Item.ReadWrite.All

Microsoft Entra identidades com suporte

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Support
Utilizador	Yes
Entidade de serviço e identidades gerenciadas	Yes

Interfase

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
graphModelId	path	True	string (uuid)	A ID do GraphModel.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.
format	query		string	O formato da definição pública GraphModel.

Respostas

Nome	Tipo	Description
200 OK	GraphModelDefinitionResponse	Solicitação concluída com êxito.
202 Accepted		Solicitação aceita. A recuperação da definição está em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	O limite de taxa de serviço foi excedido. O servidor retorna um `Retry-After` cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: OperationNotSupportedForItem – Operação sem suporte para o item solicitado.

Exemplos

Get a GraphModel public definition example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
      }
    ]
  }
}

Código de status:: 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

Definições

Nome	Description
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
GraphModelDefinitionFormat	O formato da definição do item. Tipos de `format` adicionais podem ser adicionados ao longo do tempo.
GraphModelDefinitionResponse	Resposta de definição pública do GraphModel.
GraphModelPublicDefinition	Objeto de definição pública GraphModel. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública do GraphModel.
GraphModelPublicDefinitionPart	Objeto de parte de definição GraphModel.
PayloadType	O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

GraphModelDefinitionFormat

Enumeração

O formato da definição do item. Tipos de format adicionais podem ser adicionados ao longo do tempo.

Valor	Description
json	Formato JSON para a definição pública GraphModel, especificamente projetada para dar suporte a cenários de CI/CD no Fabric.

GraphModelDefinitionResponse

Objeto

Resposta de definição pública do GraphModel.

Nome	Tipo	Description
definition	GraphModelPublicDefinition	Objeto de definição pública GraphModel. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública do GraphModel.

GraphModelPublicDefinition

Objeto

Objeto de definição pública GraphModel. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública do GraphModel.

Nome	Tipo	Description
format	GraphModelDefinitionFormat	O formato da definição do item. Tipos de `format` adicionais podem ser adicionados ao longo do tempo.
parts	GraphModelPublicDefinitionPart[]	Uma lista de partes de definição.

GraphModelPublicDefinitionPart

Objeto

Objeto de parte de definição GraphModel.

Nome	Tipo	Description
path	string	O caminho da parte de definição pública do GraphModel.
payload	string	O conteúdo da parte de definição pública do GraphModel.
payloadType	PayloadType	O tipo de conteúdo.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
InlineBase64	Base 64 embutida.

Compartilhar via

Items - Get Graph Model Definition

Permissions

Escopos delegados necessários

Microsoft Entra identidades com suporte

Interfase

Parâmetros de URI

Respostas

Exemplos

Get a GraphModel public definition example

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModelDefinitionFormat

GraphModelDefinitionResponse

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

PayloadType