Item Lifecycle - On Delete Item

Service:: Workload Development

API-versie:: v1

Aangeroepen door Microsoft Fabric voor het verwijderen van een bestaand item.
Bij het verwijderen van items voert Fabric basisvalidaties uit en roept u deze API aan om de werkbelasting op de hoogte te stellen. De werkbelasting wordt verwacht dat de metagegevens van het item en de gratis resources worden verwijderd.

De aanvraag bevat een deleteType vermelding die aangeeft of de verwijdering hard of zacht is. Een voorlopig verwijderen betekent dat het item later kan worden hersteld via de OnRestoreItem-API, zodat de workload voldoende metagegevens en resources moet behouden om herstel te ondersteunen. Een harde verwijdering is permanent en de workload moet alle bijbehorende gegevens volledig opschonen.

Deze API moet SubjectAndApp-verificatie accepteren. In sommige gevallen is het onderwerptoken echter mogelijk niet beschikbaar.

toestemmingen

Machtigingen worden gecontroleerd door Microsoft Fabric.

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

URI-parameters

Name	In	Vereist	Type	Description
itemId	path	True	string (uuid)	De item-id.
itemType	path	True	string	Het itemtype.
workspaceId	path	True	string (uuid)	De werkruimte-ID.

Aanvraagkoptekst

Name	Vereist	Type	Description
ActivityId	True	string (uuid)	Een unieke id voor het correleren van de aanvraag met uw systeem wanneer een gebruiker interactie heeft met uw workload.
RequestId	True	string (uuid)	Een wereldwijd unieke id waarmee Fabric uw aanvraag correleert met onze logboeken. Geef deze id op bij het melden van een probleem.
Authorization	True	string	Een dubbele tokenautorisatieheader waarmee de workload de oorsprong van de aanvraag kan valideren, gebruikerscontext kan bieden en andere services kan aanroepen. Deze header heeft de volgende indeling: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	De tenant-id van de client die de aanvraag indient.

Aanvraagbody

Name	Vereist	Type	Description
deleteType	True	DeleteType	Het type verwijderbewerking.

Antwoorden

Name	Type	Description
200 OK		Succesvol verwijderd.
Other Status Codes	ErrorResponse	Voor foutvoorwaarden moet de workload een geschikte HTTP-foutcode (4xx, 5xx) retourneren met gedetailleerde foutinformatie in de hoofdtekst van het antwoord.

Voorbeelden

Delete item example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

Definities

Name	Description
DeleteType	Het type verwijderbewerking.
ErrorExtendedInformation	De uitgebreide foutinformatie.
ErrorResponse	Het foutbericht.
ErrorSource	De bron van de fout.
NameValuePair	Een naam-waardepaar.
OnDeleteItemRequest	Aanvraagtekst voor het verwijderen van een item.

DeleteType

Opsomming

Het type verwijderbewerking.

Waarde	Description
Hard	Een harde verwijderbewerking.
Soft	Een bewerking voor voorlopig verwijderen.

ErrorExtendedInformation

Object

De uitgebreide foutinformatie.

Name	Type	Description
additionalParameters	NameValuePair[]	Een lijst met aanvullende parameters die specifiek zijn voor de fout.
errorCode	string	De foutcode.
message	string	Het foutbericht.
messageParameters	string[]	Een lijst met parameters voor het opmaken van een gelokaliseerd bericht.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	De foutcode.
isPermanent	boolean	Geeft aan of de fout permanent is of dat de bewerking opnieuw kan worden geprobeerd.
message	string	Het foutbericht.
messageParameters	string[]	Een lijst met parameters voor het opmaken van een gelokaliseerd bericht.
moreDetails	ErrorExtendedInformation[]	Een lijst met aanvullende foutdetails.
source	ErrorSource	De bron van de fout.

ErrorSource

Opsomming

De bron van de fout.

Waarde	Description
System	De fout is afkomstig van het systeem.
User	De fout is afkomstig van gebruikersinvoer.
External	De fout is afkomstig van een externe bron.

NameValuePair

Object

Een naam-waardepaar.

Name	Type	Description
name	string	De naam.
value	string	De waarde.

OnDeleteItemRequest

Object

Aanvraagtekst voor het verwijderen van een item.

Name	Type	Description
deleteType	DeleteType	Het type verwijderbewerking.