Item Lifecycle - On Delete Item

Dienst:: Workload Development

API-Version:: v1

Wird von Microsoft Fabric zum Löschen eines vorhandenen Elements aufgerufen.
Beim Löschen von Elementen führt Fabric grundlegende Überprüfungen durch und ruft diese API auf, um die Workload zu benachrichtigen. Die Arbeitsauslastung wird erwartet, dass die Elementmetadaten gelöscht und Ressourcen freigegeben werden.

Die Anforderung enthält einen deleteType Hinweis darauf, ob die Löschung hart oder weich ist. Ein vorläufiges Löschen bedeutet, dass das Element später über die OnRestoreItem-API wiederhergestellt werden kann, sodass die Arbeitsauslastung ausreichende Metadaten und Ressourcen aufbewahren sollte, um die Wiederherstellung zu unterstützen. Ein endgültiger Löschvorgang ist dauerhaft, und die Workload sollte alle zugehörigen Daten vollständig bereinigen.

Diese API sollte die SubjectAndApp-Authentifizierung akzeptieren. Das Betrefftoken ist jedoch in einigen Fällen möglicherweise nicht verfügbar.

Erlaubnisse

Berechtigungen werden durch Microsoft Fabric überprüft.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
itemId	path	True	string (uuid)	Die Element-ID.
itemType	path	True	string	Der Elementtyp.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
ActivityId	True	string (uuid)	Eine eindeutige ID zum Korrelieren der Anforderung mit Ihrem System, wenn ein Benutzer mit Ihrer Workload interagiert.
RequestId	True	string (uuid)	Eine global eindeutige ID, die Fabric dabei hilft, Ihre Anforderung mit unseren Protokollen zu korrelieren. Geben Sie diese ID an, wenn ein Problem gemeldet wird.
Authorization	True	string	Ein Dual-Token-Autorisierungsheader, der es der Workload ermöglicht, den Anforderungsursprung zu überprüfen, Den Benutzerkontext bereitzustellen und andere Dienste aufzurufen. Diese Kopfzeile hat das folgende Format: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	Die Mandanten-ID des Clients, der die Anforderung stellt.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
deleteType	True	DeleteType	Der Typ des Löschvorgangs.

Antworten

Name	Typ	Beschreibung
200 OK		Erfolgreich gelöscht.
Other Status Codes	ErrorResponse	Bei Fehlerbedingungen sollte die Workload einen entsprechenden HTTP-Fehlerstatuscode (4xx, 5xx) mit detaillierten Fehlerinformationen im Antworttext zurückgeben.

Beispiele

Delete item example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 200

Definitionen

Name	Beschreibung
DeleteType	Der Typ des Löschvorgangs.
ErrorExtendedInformation	Die erweiterten Fehlerinformationen.
ErrorResponse	Die Fehlerantwort.
ErrorSource	Die Ursache des Fehlers.
NameValuePair	Ein Name-Wert-Paar.
OnDeleteItemRequest	Anforderungstext zum Löschen eines Elements.

DeleteType

Enumeration

Der Typ des Löschvorgangs.

Wert	Beschreibung
Hard	Ein endgültiger Löschvorgang.
Soft	Ein Vorgang zum vorläufigen Löschen.

ErrorExtendedInformation

Objekt

Die erweiterten Fehlerinformationen.

Name	Typ	Beschreibung
additionalParameters	NameValuePair[]	Eine Liste mit zusätzlichen Parametern, die für den Fehler spezifisch sind.
errorCode	string	Der Fehlercode.
message	string	Die Fehlermeldung.
messageParameters	string[]	Eine Liste der Parameter zum Formatieren einer lokalisierten Nachricht.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
isPermanent	boolean	Gibt an, ob der Fehler dauerhaft ist oder der Vorgang wiederholt werden kann.
message	string	Die Fehlermeldung.
messageParameters	string[]	Eine Liste der Parameter zum Formatieren einer lokalisierten Nachricht.
moreDetails	ErrorExtendedInformation[]	Eine Liste mit zusätzlichen Fehlerdetails.
source	ErrorSource	Die Ursache des Fehlers.

ErrorSource

Enumeration

Die Ursache des Fehlers.

Wert	Beschreibung
System	Der Fehler stammt aus dem System.
User	Der Fehler stammt von der Benutzereingabe.
External	Der Fehler stammt aus einer externen Quelle.

NameValuePair

Objekt

Ein Name-Wert-Paar.

Name	Typ	Beschreibung
name	string	Der Name.
value	string	Der -Wert.

OnDeleteItemRequest

Objekt

Anforderungstext zum Löschen eines Elements.

Name	Typ	Beschreibung
deleteType	DeleteType	Der Typ des Löschvorgangs.