Item Lifecycle - On Delete Item

Tjeneste:: Workload Development

API-versjon:: v1

Kalt av Microsoft Fabric for sletting av et eksisterende element.
Ved sletting av element utfører Fabric grunnleggende valideringer og kaller opp denne API-en for å varsle arbeidsbelastningen. Arbeidsmengden forventes å slette elementmetadataene og gratisressurser.

Forespørselen inneholder et deleteType som angir om slettingen er hard eller myk. En myk sletting betyr at elementet kan gjenopprettes senere via API-en OnRestoreItem, så arbeidsbelastningen bør beholde tilstrekkelige metadata og ressurser til å støtte gjenoppretting. En hard sletting er permanent, og arbeidsbelastningen skal rydde opp i alle tilknyttede data.

Denne API-en må godta SubjectAndApp-godkjenning. Emnetokenet kan imidlertid være utilgjengelig i enkelte tilfeller.

Tillatelser

Tillatelser kontrolleres av Microsoft Fabric.

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}/OnDeleteItem

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
itemId	path	True	string (uuid)	Element-ID-en.
itemType	path	True	string	Elementtypen.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Topptekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
ActivityId	True	string (uuid)	En unik ID for å korrelere forespørselen med systemet når en bruker samhandler med arbeidsbelastningen.
RequestId	True	string (uuid)	En globalt unik ID som hjelper Fabric med å koordinere forespørselen din med loggene våre. Oppgi denne ID-en når du rapporterer et problem.
Authorization	True	string	Et autorisasjonshode med to tokener som gjør det mulig for arbeidsbelastningen å validere forespørselens opprinnelse, gi brukerkontekst og ringe andre tjenester. Denne toppteksten har følgende format: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	Leier-ID-en til klienten som foretar forespørselen.

Brødtekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
deleteType	True	DeleteType	Typen sletteoperasjon.

Svar

Navn	Type	Beskrivelse
200 OK		Slettet.
Other Status Codes	ErrorResponse	For feilforhold bør arbeidsbelastningen returnere en passende HTTP-feilstatuskode (4xx, 5xx) med detaljert feilinformasjon i svarteksten.

Eksempler

Delete item example

Eksempelforespørsel

HTTP

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111/OnDeleteItem

{
  "deleteType": "Hard"
}

Eksempelsvar

Statuskode:: 200

Definisjoner

Navn	Beskrivelse
DeleteType	Typen sletteoperasjon.
ErrorExtendedInformation	Den utvidede feilinformasjonen.
ErrorResponse	Feilsvaret.
ErrorSource	Kilden til feilen.
NameValuePair	Et navneverdipar.
OnDeleteItemRequest	Be om brødtekst for sletting av et element.

DeleteType

Opplisting

Typen sletteoperasjon.

Verdi	Beskrivelse
Hard	En hard sletteoperasjon.
Soft	En myk sletteoperasjon.

ErrorExtendedInformation

Objekt

Den utvidede feilinformasjonen.

Navn	Type	Beskrivelse
additionalParameters	NameValuePair[]	En liste over flere parametere som er spesifikke for feilen.
errorCode	string	Feilkoden.
message	string	Feilmeldingen.
messageParameters	string[]	En liste over parametere som formaterer en lokalisert melding.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	Feilkoden.
isPermanent	boolean	Angir om feilen er permanent eller operasjonen kan prøves på nytt.
message	string	Feilmeldingen.
messageParameters	string[]	En liste over parametere som formaterer en lokalisert melding.
moreDetails	ErrorExtendedInformation[]	En liste over flere feildetaljer.
source	ErrorSource	Kilden til feilen.

ErrorSource

Opplisting

Kilden til feilen.

Verdi	Beskrivelse
System	Feilen stammer fra systemet.
User	Feilen stammer fra brukerinndata.
External	Feilen stammer fra en ekstern kilde.

NameValuePair

Objekt

Et navneverdipar.

Navn	Type	Beskrivelse
name	string	Navnet.
value	string	Verdien.

OnDeleteItemRequest

Objekt

Be om brødtekst for sletting av et element.

Navn	Type	Beskrivelse
deleteType	DeleteType	Typen sletteoperasjon.