Item Lifecycle - On Delete Item

Servizio:: Workload Development

Versione API:: v1

Chiamato da Microsoft Fabric per eliminare un elemento esistente.
Al momento dell'eliminazione di elementi Fabric esegue le convalide di base e chiama questa API per notificare il carico di lavoro. Si prevede che il carico di lavoro elimini i metadati dell'elemento e le risorse gratuite.

La richiesta include un deleteType valore che indica se l'eliminazione è Hard o Soft. Un'eliminazione temporanea indica che l'elemento può essere ripristinato in un secondo momento tramite l'API OnRestoreItem, quindi il carico di lavoro deve conservare metadati e risorse sufficienti per supportare il ripristino. Un'eliminazione definitiva è permanente e il carico di lavoro deve pulire completamente tutti i dati associati.

Questa API deve accettare l'autenticazione SubjectAndApp. Tuttavia, il token soggetto potrebbe non essere disponibile in alcuni casi.

Autorizzazioni

Le autorizzazioni vengono controllate da Microsoft Fabric.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
itemId	path	True	string (uuid)	ID elemento.
itemType	path	True	string	Tipo di elemento.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
ActivityId	True	string (uuid)	ID univoco per correlare la richiesta con il sistema quando un utente interagisce con il carico di lavoro.
RequestId	True	string (uuid)	ID univoco globale che consente a Fabric di correlare la richiesta con i log. Specificare questo ID quando si segnala un problema.
Authorization	True	string	Intestazione di autorizzazione del token doppio che consente al carico di lavoro di convalidare l'origine della richiesta, fornire il contesto utente e chiamare altri servizi. Questa intestazione ha il formato seguente: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	ID tenant del client che effettua la richiesta.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
deleteType	True	DeleteType	Tipo di operazione di eliminazione.

Risposte

Nome	Tipo	Descrizione
200 OK		Cancellato con successo.
Other Status Codes	ErrorResponse	Per le condizioni di errore, il carico di lavoro deve restituire un codice di stato di errore HTTP appropriato (4xx, 5xx) con informazioni dettagliate sull'errore nel corpo della risposta.

Esempio

Delete item example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 200

Definizioni

Nome	Descrizione
DeleteType	Tipo di operazione di eliminazione.
ErrorExtendedInformation	Informazioni estese sull'errore.
ErrorResponse	Risposta di errore.
ErrorSource	Indica l'origine dell'errore.
NameValuePair	Coppia nome-valore.
OnDeleteItemRequest	Corpo della richiesta per l'eliminazione di un elemento.

DeleteType

Enumerazione

Tipo di operazione di eliminazione.

Valore	Descrizione
Hard	Operazione di eliminazione temporanea.
Soft	Operazione di eliminazione temporanea.

ErrorExtendedInformation

Oggetto

Informazioni estese sull'errore.

Nome	Tipo	Descrizione
additionalParameters	NameValuePair[]	Elenco di parametri aggiuntivi specifici dell'errore.
errorCode	string	Codice di errore.
message	string	Messaggio di errore.
messageParameters	string[]	Elenco di parametri per la formattazione di un messaggio localizzato.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Codice di errore.
isPermanent	boolean	Indica se l'errore è permanente o se l'operazione può essere ritentata.
message	string	Messaggio di errore.
messageParameters	string[]	Elenco di parametri per la formattazione di un messaggio localizzato.
moreDetails	ErrorExtendedInformation[]	Elenco di dettagli aggiuntivi sull'errore.
source	ErrorSource	Indica l'origine dell'errore.

ErrorSource

Enumerazione

Indica l'origine dell'errore.

Valore	Descrizione
System	Errore originato dal sistema.
User	Errore originato dall'input dell'utente.
External	Errore originato da un'origine esterna.

NameValuePair

Oggetto

Coppia nome-valore.

Nome	Tipo	Descrizione
name	string	Nome.
value	string	Valore .

OnDeleteItemRequest

Oggetto

Corpo della richiesta per l'eliminazione di un elemento.

Nome	Tipo	Descrizione
deleteType	DeleteType	Tipo di operazione di eliminazione.