Items - Get GraphQLApi Definition

Usługa:: GraphQLApi

Wersja interfejsu API:: v1

Zwraca określoną definicję publiczną graphQLApi.

Ten interfejs API obsługuje długotrwałych operacji (LRO).

Gdy uzyskasz publiczną definicję graphQLApi, etykieta poufności nie jest częścią definicji.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla interfejsu GraphQLApi .

Wymagane zakresy delegowane

GraphQLApi.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Ten interfejs API jest blokowany dla obiektu z zaszyfrowaną etykietą poufności.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
graphQLApiId	path	True	string (uuid)	Identyfikator graphQLApi.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
format	query		string	Format definicji publicznej graphQLApi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GraphQLApiDefinitionResponse	Żądanie zostało ukończone pomyślnie.
202 Accepted		Zaakceptowano żądanie. Pobieranie definicji jest w toku. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

Przykłady

Get a GraphQLApi public definition example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "graphql-definition.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Kod stanu:: 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

Definicje

Nazwa	Opis
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
GraphQLApiDefinitionResponse	Odpowiedź interfejsu API dla publicznej definicji graphQL.
GraphQLApiPublicDefinition	Obiekt definicji publicznej interfejsu API GraphQL. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji interfejsu API GraphQL.
GraphQLApiPublicDefinitionPart	Interfejs API dla obiektu części definicji programu GraphQL.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

GraphQLApiDefinitionResponse

Objekt

Odpowiedź interfejsu API dla publicznej definicji graphQL.

Nazwa	Typ	Opis
definition	GraphQLApiPublicDefinition	Obiekt definicji publicznej interfejsu API GraphQL. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji interfejsu API GraphQL.

GraphQLApiPublicDefinition

Objekt

Obiekt definicji publicznej interfejsu API GraphQL. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji interfejsu API GraphQL.

Nazwa	Typ	Opis
format	string	Format definicji GraphQL.
parts	GraphQLApiPublicDefinitionPart[]	Lista części definicji.

GraphQLApiPublicDefinitionPart

Objekt

Interfejs API dla obiektu części definicji programu GraphQL.

Nazwa	Typ	Opis
path	string	Ścieżka części definicji programu GraphQL interfejsu API.
payload	string	Ładunek części definicji programu GraphQL dla interfejsu API.
payloadType	PayloadType	Typ ładunku.

PayloadType

Wyliczenie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość	Opis
InlineBase64	Śródliniowa baza 64.