Items - Delete Item

Usługa:: Core

Wersja interfejsu API:: v1

Usuwa określony element.
Ten interfejs API jest obsługiwany w przypadku wielu typów elementów, znajdź obsługiwane typy elementów i informacje o ich strukturze definicji w Omówienie zarządzania elementami. Domyślnym zachowaniem jest usuwanie nietrwałe elementu dla obsługiwanych typów elementów.

Uwaga / Notatka

Elementy usunięte nietrwale zostaną zliczane do maksymalnej liczby elementów dozwolonych w każdym obszarze roboczym.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do zapisu dla elementu w celu usunięcia nietrwałego. Obiekt wywołujący musi mieć przypisaną rolę administratora obszaru roboczego w celu trwałego usunięcia.

Wymagane zakresy delegowane

W przypadku interfejsów API elementów użyj następujących typów zakresów:

Zakres ogólny: Item.ReadWrite.All
Określony zakres: itemType. ReadWrite.All (na przykład: Notebook.ReadWrite.All)

Aby uzyskać więcej informacji na temat zakresów, zobacz artykuł zakresy.

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	Gdy typ elementu w wywołaniu jest obsługiwany. Sprawdź odpowiedni interfejs API dla wywoływanego typu elementu, aby sprawdzić, czy wywołanie jest obsługiwane. Na przykład modele semantyczne są obsługiwane.

Interfejs

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}

Z parametrami opcjonalnymi:

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}?hardDelete={hardDelete}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
itemId	path	True	string (uuid)	Identyfikator elementu.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
hardDelete	query		boolean	Określa, czy wykonać usuwanie twarde. Po ustawieniu `true`wartoś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

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.

Żą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 item example

Hard delete an item example

Delete an item example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

Hard delete an item example

Przykładowe żądanie

HTTP

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/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.
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.