Items - Get Graph Model Definition

Serviço:: GraphModel

Versão da API:: v1

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

Observação

O item GraphModel está atualmente em Pré-visualização (saiba mais).

Esta API suporta operações de longa duração (LRO).

Quando você obtém a definição pública de um GraphModel, o rótulo de sensibilidade 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

Identidades suportadas pela Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Support
User	Yes
Entidade de serviço e identidades geridas	Yes

Interfaz

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 do URI

Name	Em	Necessário	Tipo	Description
graphModelId	path	True	string (uuid)	O ID do GraphModel.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.
format	query		string	O formato da definição pública do GraphModel.

Respostas

Name	Tipo	Description
200 OK	GraphModelDefinitionResponse	Pedido concluído com sucesso.
202 Accepted		Pedido aceite. Está em curso a recuperação da definição. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	O limite de tarifa de serviço foi ultrapassado. O servidor devolve um `Retry-After` cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: OperationNotSupportedForItem - Operação não suportada para o item solicitado.

Exemplos

Get a GraphModel public definition example

Pedido de amostra

HTTP

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

Resposta da amostra

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

Name	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 GraphModel.
GraphModelPublicDefinition	Objeto de definição pública GraphModel. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública GraphModel.
GraphModelPublicDefinitionPart	Objeto de parte de definição GraphModel.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

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

ErrorResponse

Object

A resposta de erro.

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

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados 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, projetado especificamente para suportar cenários de CI/CD na malha.

GraphModelDefinitionResponse

Object

Resposta de definição pública GraphModel.

Name	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 GraphModel.

GraphModelPublicDefinition

Object

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

Name	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

Object

Objeto de parte de definição GraphModel.

Name	Tipo	Description
path	string	O caminho da parte de definição pública GraphModel.
payload	string	A carga útil da parte de definição pública do GraphModel.
payloadType	PayloadType	O tipo de carga útil.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor	Description
InlineBase64	Base em linha 64.

Partilhar via

Items - Get Graph Model Definition

Permissions

Escopos delegados necessários

Identidades suportadas pela Microsoft Entra

Interfaz

Parâmetros do URI

Respostas

Exemplos

Get a GraphModel public definition example

Pedido de amostra

Resposta da amostra

Definições

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModelDefinitionFormat

GraphModelDefinitionResponse

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

PayloadType