Items - Update GraphQLApi Definition

Usługa:

GraphQLApi

Wersja interfejsu API:

v1

Zastępuje definicję określonego elementu .

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

Aktualizowanie definicji interfejsu GraphQLApi nie ma wpływu na etykietę poufności.

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

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, z wyjątkiem ładunku definicji z punktem końcowym analizy SQL

Interfejs

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/updateDefinition

Z parametrami opcjonalnymi:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/updateDefinition?updateMetadata={updateMetadata}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
GraphQLApiId	path	True	string (uuid)	Identyfikator graphQLApi.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
updateMetadata	query		boolean	W przypadku ustawienia wartości true i pliku platformy w ramach definicji metadane elementu są aktualizowane przy użyciu metadanych w pliku platformy .

Treść żądania

Nazwa	Wymagane	Typ	Opis
definition	True	GraphQLApiPublicDefinition	Interfejs API dla obiektu definicji publicznej GraphQL. Aby utworzyć definicję, zobacz GraphQLApi definition (Definicja interfejsu GraphQLApi).

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Żądanie zostało ukończone pomyślnie.
202 Accepted		Zaakceptowano żądanie. Trwa aktualizowanie definicji. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu. CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

Update a GraphQLApi public definition example

Przykładowe żądanie

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GraphQLApis/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Przykładowa odpowiedź

Kod stanu:

200

Kod stanu:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
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.
GraphQLApiPublicDefinition	Interfejs API dla obiektu definicji publicznej GraphQL. Aby utworzyć definicję, zobacz GraphQLApi definition (Definicja interfejsu GraphQLApi).
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.
UpdateGraphQLApiDefinitionRequest	Aktualizowanie interfejsu API dla ładunku żądania definicji publicznej graphQL.

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

GraphQLApiPublicDefinition

Objekt

Interfejs API dla obiektu definicji publicznej GraphQL. Aby utworzyć definicję, zobacz GraphQLApi definition (Definicja interfejsu GraphQLApi).

Nazwa	Typ	Opis
format	string	Format definicji elementu.
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

Wyliczanie

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

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

UpdateGraphQLApiDefinitionRequest

Objekt

Aktualizowanie interfejsu API dla ładunku żądania definicji publicznej graphQL.

Nazwa	Typ	Opis
definition	GraphQLApiPublicDefinition	Interfejs API dla obiektu definicji publicznej GraphQL. Aby utworzyć definicję, zobacz GraphQLApi definition (Definicja interfejsu GraphQLApi).