Del via

Items - Delete Item

Tjeneste:
Core
API-version:
v1

Sletter det angivne element.
Denne API understøttes for en række elementtyper. Find de understøttede elementtyper og oplysninger om deres definitionsstruktur i oversigt over elementstyring. Standardfunktionsmåden er blød sletning af elementet for understøttede elementtyper.

Bemærkning

De elementer, der er slettet midlertidigt, tælles mod det maksimale antal elementer, der er tilladt i hvert arbejdsområde.

Tilladelser

Den, der ringer op, skal have skriverettigheder til elementet til blød sletning. Den, der ringer op, skal have tildelt arbejdsområdets administratorrolle til hård/permanent sletning.

Påkrævede delegerede områder

For element-API'er skal du bruge disse områdetyper:

  • Standardområde: Item.ReadWrite.All
  • Bestemt område: itemType. ReadWrite.All (f.eks. Notebook.ReadWrite.All)

Du kan få flere oplysninger om områder i artiklen om områder.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet Støtte
Bruger Ja
tjenesteprincipal og administrerede identiteter Når elementtypen i opkaldet understøttes. Kontrollér den tilsvarende API for den elementtype, du ringer til, for at se, om dit opkald understøttes. Semantiske modeller understøttes f.eks.

Grænseflade

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

URI-parametre

Name I Påkrævet Type Beskrivelse
itemId
 path True

string (uuid)

Element-id'et.
workspaceId
 path True

string (uuid)

Arbejdsområde-id'et.
hardDelete
 query

boolean

Angiver, om der skal udføres en hård sletning. Når den er angivet til true, slettes elementet permanent og kan ikke gendannes. Når elementet er angivet til false eller ikke er angivet, slettes det midlertidigt, hvis elementtypen understøtter det.

Svar

Name Type Beskrivelse
200 OK

Anmodningen blev fuldført.
429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • ItemNotFound – Det ønskede element blev ikke fundet.

  • InsufficientWorkspaceRole – Brugeren har ikke tilstrækkelig rolle i arbejdsområdet.

  • FeatureNotAvailable – Dette kan skyldes, at funktionen til blød sletning ikke er tilgængelig.

  • Ikke-understøttetItemType – Dette kan skyldes, at funktionen til blød sletning ikke understøttes af den ønskede elementtype.

  • TenantSwitchDisabled – Dette kan skyldes, at funktionen til blød sletning er deaktiveret af lejeradministratoren.

  • InvalidTargetItemStateForSoftDeletion – Elementet er i ugyldige tilstande til blød sletning.

  • InvalidParentItemStateForSoftDeletion – Elementets overordnede element er ikke i aktiv tilstand.

Eksempler

Delete an item example
Hard delete an item example

Delete an item example

Eksempelanmodning

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

Eksempelsvar

Statuskode:
200

Hard delete an item example

Eksempelanmodning

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

Eksempelsvar

Statuskode:
200

Definitioner

Name Beskrivelse
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.