Item Lifecycle - On Delete Item

Palvelu:: Workload Development

Ohjelmointirajapinnan versio:: v1

Microsoft Fabric kutsutaan aiemmin luodun kohteen poistamista varten.
Kun kohde poistetaan, Fabric suorittaa perustason vahvistukset ja kutsuu tätä ohjelmointirajapintaa ilmoittamaan siitä kuormitukselle. Kuormituksen odotetaan poistavan kohteen metatiedot ja ilmaiset resurssit.

Pyyntö sisältää deleteType tiedon siitä, onko poistaminen kova vai pehmeä. Pehmeä poisto tarkoittaa, että kohde voidaan palauttaa myöhemmin OnRestoreItem-ohjelmointirajapinnan kautta, joten kuormituksen tulisi säilyttää riittävät metatiedot ja resurssit restauroinnin tukemiseksi. Kova poisto on pysyvä, ja kuormituksen pitäisi tyhjentää kaikki liittyvät tiedot kokonaan.

Tämän ohjelmointirajapinnan tulee hyväksyä SubjectAndApp-todennus. Aihetunnus ei ehkä kuitenkaan ole käytettävissä joissain tapauksissa.

Käyttöoikeudet

Microsoft Fabric tarkistaa oikeudet.

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
itemId	path	True	string (uuid)	Kohdetunnus.
itemType	path	True	string	Kohdetyyppi.
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön otsikko

Nimi	Pakollinen	Tyyppi	Description
ActivityId	True	string (uuid)	Yksilöivä tunnus pyynnön korreloimiseen järjestelmän kanssa, kun käyttäjä on vuorovaikutuksessa kuormituksesi kanssa.
RequestId	True	string (uuid)	Globaalisti yksilöivä tunnus, jonka avulla Fabric korreloi pyyntösi lokeihin. Anna tämä tunnus, kun ilmoitat ongelmasta.
Authorization	True	string	Kaksoistunnus-valtuutusotsikko, jonka avulla kuormitus voi vahvistaa pyynnön alkuperän, tarjota käyttäjäkontekstin ja kutsua muita palveluita. Tämä otsikko on seuraavassa muodossa: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	Pyynnön tekevän asiakkaan vuokraajatunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
deleteType	True	DeleteType	Poistamistoiminnon tyyppi.

Vastaukset

Nimi	Tyyppi	Description
200 OK		Poistettiin onnistuneesti.
Other Status Codes	ErrorResponse	Virhetilanteissa kuormituksen tulisi palauttaa asianmukainen HTTP-virheen tilakoodi (4xx, 5xx), jossa on yksityiskohtaisia virhetietoja vastauksen tekstiosassa.

Esimerkit

Delete item example

Mallipyyntö

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"
}

Mallivastaus

Tilakoodi:: 200

Määritelmät

Nimi	Description
DeleteType	Poistamistoiminnon tyyppi.
ErrorExtendedInformation	Laajennetut virhetiedot.
ErrorResponse	Virhevastaus.
ErrorSource	Virheen lähde.
NameValuePair	Nimi–arvo-pari.
OnDeleteItemRequest	Pyydä leipätekstiä kohteen poistamiseen.

DeleteType

Luettelointi

Poistamistoiminnon tyyppi.

Arvo	Description
Hard	Pysyvä poistotoiminto.
Soft	Pehmeä poistotoiminto.

ErrorExtendedInformation

Kohde

Laajennetut virhetiedot.

Nimi	Tyyppi	Description
additionalParameters	NameValuePair[]	Luettelo virheen muista parametreista.
errorCode	string	Virhekoodi.
message	string	Virhesanoma.
messageParameters	string[]	Lokalisoidun sanoman muotoilun parametrien luettelo.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Virhekoodi.
isPermanent	boolean	Ilmaisee, onko virhe pysyvä vai voidaanko toimintoa yrittää uudelleen.
message	string	Virhesanoma.
messageParameters	string[]	Lokalisoidun sanoman muotoilun parametrien luettelo.
moreDetails	ErrorExtendedInformation[]	Luettelo virheiden lisätiedoista.
source	ErrorSource	Virheen lähde.

ErrorSource

Luettelointi

Virheen lähde.

Arvo	Description
System	Virhe oli peräisin järjestelmästä.
User	Virhe oli peräisin käyttäjän syötteestä.
External	Virhe oli peräisin ulkoisesta lähteestä.

NameValuePair

Kohde

Nimi–arvo-pari.

Nimi	Tyyppi	Description
name	string	Nimi.
value	string	Arvo.

OnDeleteItemRequest

Kohde

Pyydä leipätekstiä kohteen poistamiseen.

Nimi	Tyyppi	Description
deleteType	DeleteType	Poistamistoiminnon tyyppi.