Items - Delete GraphQLApi

Usługa:
GraphQLApi
Wersja interfejsu API:
v1

Usuwa określony interfejs API dla języka GraphQL.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do 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

Interfejs

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphQLApis/{graphQLApiId}
Z parametrami opcjonalnymi: 
DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphQLApis/{graphQLApiId}?hardDelete={hardDelete}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
graphQLApiId
 path True

string (uuid)

Interfejs API dla identyfikatora GraphQL.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
hardDelete
 query

boolean

Określa, czy wykonać usuwanie twarde. Po ustawieniu truewartości na element zostanie trwale usunięty i nie można go odzyskać. W przypadku ustawienia false wartości lub nieokreślonej element jest usuwany nietrwale, jeśli typ elementu go obsługuje.

Odpowiedzi

Nazwa Typ Opis
200 OK

Żądanie zostało ukończone pomyślnie.
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:

  • ItemNotFound — żądany element nie został znaleziony.

  • InsufficientWorkspaceRole — użytkownik nie ma wystarczającej roli obszaru roboczego.

  • FeatureNotAvailable — może to być spowodowane niedostępną funkcją usuwania nietrwałego.

  • Nieobsługiwany typ elementu — może to być spowodowane tym, że funkcja usuwania nietrwałego nie jest obsługiwana przez żądany typ elementu.

  • TenantSwitchDisabled — może to być spowodowane wyłączeniem funkcji usuwania nietrwałego przez administratora dzierżawy.

  • InvalidTargetItemStateForSoftDeletion — element jest w nieprawidłowych stanach usuwania nietrwałego.

  • InvalidParentItemStateForSoftDeletion — element nadrzędny elementu nie jest w stanie Aktywny.

Przykłady

Delete an API for GraphQL example
Hard delete an API for GraphQL example

Delete an API for GraphQL example

Przykładowe żądanie

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/graphQLApis/5b218778-e7a5-4d73-8187-f10824047715

Przykładowa odpowiedź

Kod stanu:
200

Hard delete an API for GraphQL example

Przykładowe żądanie

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/graphQLApis/5b218778-e7a5-4d73-8187-f10824047715?hardDelete=True

Przykładowa odpowiedź

Kod stanu:
200

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.

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.