Item Lifecycle - On Delete Item

Tjeneste:: Workload Development

API-version:: v1

Kaldes af Microsoft Fabric til sletning af et eksisterende element.
Ved elementsletning udfører Fabric grundlæggende valideringer og kalder denne API for at give besked om arbejdsbelastningen. Arbejdsbelastningen forventes at slette elementmetadata og gratis ressourcer.

Anmodningen indeholder en deleteType , der angiver, om sletningen er Hård eller Blød. En blød sletning betyder, at elementet kan gendannes senere via OnRestoreItem-API'en, så arbejdsbelastningen skal bevare tilstrækkelige metadata og ressourcer til at understøtte gendannelse. En hård sletning er permanent, og arbejdsbelastningen bør rydde op i alle tilknyttede data fuldt ud.

Denne API skal acceptere SubjectAndApp-godkendelse. Emnetokenet kan dog være utilgængeligt i nogle tilfælde.

Tilladelser

Tilladelser kontrolleres af Microsoft Fabric.

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
itemId	path	True	string (uuid)	Element-id'et.
itemType	path	True	string	Elementtypen.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Overskrift på anmodning

Name	Påkrævet	Type	Beskrivelse
ActivityId	True	string (uuid)	Et entydigt id til at korrelere anmodningen med dit system, når en bruger interagerer med din arbejdsbelastning.
RequestId	True	string (uuid)	Et globalt entydigt id, der hjælper Fabric med at korrelere din anmodning med vores logge. Angiv dette id, når du rapporterer et problem.
Authorization	True	string	En tokengodkendelsesheader, der gør det muligt for arbejdsbelastningen at validere anmodningens oprindelse, angive brugerkontekst og kalde andre tjenester. Denne header har følgende format: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	Lejer-id'et for den klient, der foretager anmodningen.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
deleteType	True	DeleteType	Typen af sletningshandling.

Svar

Name	Type	Beskrivelse
200 OK		Slettet.
Other Status Codes	ErrorResponse	I forbindelse med fejlbetingelser skal arbejdsbelastningen returnere en passende HTTP-fejlstatuskode (4xx, 5xx) med detaljerede fejloplysninger i svarets brødtekst.

Eksempler

Delete item example

Eksempelanmodning

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

Definitioner

Name	Beskrivelse
DeleteType	Typen af sletningshandling.
ErrorExtendedInformation	De udvidede fejloplysninger.
ErrorResponse	Fejlsvaret.
ErrorSource	Kilden til fejlen.
NameValuePair	Et navneværdipar.
OnDeleteItemRequest	Anmod om brødtekst for at slette et element.

DeleteType

Optælling

Typen af sletningshandling.

Værdi	Beskrivelse
Hard	En hård sletningshandling.
Soft	En blød sletningshandling.

ErrorExtendedInformation

Objekt

De udvidede fejloplysninger.

Name	Type	Beskrivelse
additionalParameters	NameValuePair[]	En liste over yderligere parametre, der er specifikke for fejlen.
errorCode	string	Fejlkoden.
message	string	Fejlmeddelelsen.
messageParameters	string[]	En liste over parametre til formatering af en lokaliseret meddelelse.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Fejlkoden.
isPermanent	boolean	Angiver, om fejlen er permanent, eller om handlingen kan prøves igen.
message	string	Fejlmeddelelsen.
messageParameters	string[]	En liste over parametre til formatering af en lokaliseret meddelelse.
moreDetails	ErrorExtendedInformation[]	En liste over yderligere oplysninger om fejl.
source	ErrorSource	Kilden til fejlen.

ErrorSource

Optælling

Kilden til fejlen.

Værdi	Beskrivelse
System	Fejlen stammer fra systemet.
User	Fejlen stammer fra brugerinput.
External	Fejlen stammer fra en ekstern kilde.

NameValuePair

Objekt

Et navneværdipar.

Name	Type	Beskrivelse
name	string	Navnet.
value	string	Værdien.

OnDeleteItemRequest

Objekt

Anmod om brødtekst for at slette et element.

Name	Type	Beskrivelse
deleteType	DeleteType	Typen af sletningshandling.