Items - Get GraphQLApi Definition

Serviço:: GraphQLApi

Versão da API:: v1

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

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

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

Esta API está bloqueada para um com um rótulo de sensibilidade criptografado.

Identidades suportadas pelo Entra da Microsoft

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

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

Interfaz

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

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

Respostas

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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

GraphQLApiDefinitionResponse

Object

API para resposta de definição pública do GraphQL.

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

GraphQLApiPublicDefinition

Object

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

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

GraphQLApiPublicDefinitionPart

Object

API para objeto de parte de definição do GraphQL.

Name	Tipo	Description
path	string	O caminho da parte de definição da API para GraphQL.
payload	string	A API para a carga útil parcial de definição do GraphQL.
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.