Items - Get GraphQLApi Definition

Serviço:: GraphQLApi

Versão da API:: v1

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

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

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

Permissões

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

Escopos delegados necessários

GraphQLApi.ReadWrite.All ou Item.ReadWrite.All

Limitações

Essa API é bloqueada para um rótulo de confidencialidade criptografado.

Identidades com suporte do Microsoft Entra

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

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades gerenciadas	Sim

Interfase

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphQLApis/{graphQLApiId}/getDefinition

Com parâmetros opcionais:

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

Parâmetros de URI

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

Respostas

Nome	Tipo	Description
200 OK	GraphQLApiDefinitionResponse	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 GraphQLApi public definition example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "definition": {
    "parts": [
      {
        "path": "graphql-definition.json",
        "payload": "ew0KICAiZXhlY3V0YW..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.
GraphQLApiDefinitionResponse	Resposta de definição pública da API para GraphQL.
GraphQLApiPublicDefinition	Objeto de definição pública da API do GraphQL. Consulte este artigo para obter mais detalhes sobre a estrutura da definição da API do GraphQL.
GraphQLApiPublicDefinitionPart	Objeto de parte de definição da API para GraphQL.
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.
isRetriable	boolean	Quando true, a solicitação pode ser repetida. Use o `Retry-After` cabeçalho de resposta para determinar o atraso, se disponível.
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.

GraphQLApiDefinitionResponse

Objeto

Resposta de definição pública da API para GraphQL.

Nome	Tipo	Description
definition	GraphQLApiPublicDefinition	Objeto de definição pública da API do GraphQL. Consulte este artigo para obter mais detalhes sobre a estrutura da definição da API do GraphQL.

GraphQLApiPublicDefinition

Objeto

Objeto de definição pública da API do GraphQL. Consulte este artigo para obter mais detalhes sobre a estrutura da definição da API do GraphQL.

Nome	Tipo	Description
format	string	O formato da definição do GraphQL.
parts	GraphQLApiPublicDefinitionPart[]	Uma lista de partes de definição.

GraphQLApiPublicDefinitionPart

Objeto

Objeto de parte de definição da API para GraphQL.

Nome	Tipo	Description
path	string	O caminho da parte de definição da API para GraphQL.
payload	string	O conteúdo da parte de definição da API para GraphQL.
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.