Item Lifecycle - On Delete Item

Serviço:: Workload Development

Versão da API:: v1

Chamado pela Microsoft Fabric por eliminar um item existente.
Após a eliminação do item, o Fabric realiza validações básicas e chama esta API para notificar a carga de trabalho. Espera-se que a carga de trabalho elimine os metadados do item e os recursos gratuitos.

O pedido inclui uma deleteType indicação se a eliminação é Hard ou Soft. Uma eliminação suave significa que o item pode ser restaurado mais tarde através da API OnRestoreItem, pelo que a carga de trabalho deve manter metadados e recursos suficientes para suportar a restauração. Uma eliminação forçada é permanente e a carga de trabalho deve limpar completamente todos os dados associados.

Esta API deve aceitar autenticação SubjectAndApp. No entanto, o token em questão pode não estar disponível em alguns casos.

Permissões

As permissões são verificadas pelo Microsoft Fabric.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
itemId	path	True	string (uuid)	O ID do item.
itemType	path	True	string	O tipo de item.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
ActivityId	True	string (uuid)	Um ID único para correlacionar o pedido com o seu sistema quando um utilizador interage com a sua carga de trabalho.
RequestId	True	string (uuid)	Um ID globalmente único que ajuda o Fabric a correlacionar o seu pedido com os nossos registos. Forneça este ID ao reportar um problema.
Authorization	True	string	Um cabeçalho de autorização de token duplo que permite à carga de trabalho validar a origem do pedido, fornecer contexto ao utilizador e chamar outros serviços. Este cabeçalho tem o seguinte formato: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	O ID do locatário do cliente que faz a solicitação.

Corpo do Pedido

Name	Necessário	Tipo	Description
deleteType	True	DeleteType	O tipo de operação de eliminação.

Respostas

Name	Tipo	Description
200 OK		Eliminado com sucesso.
Other Status Codes	ErrorResponse	Para condições de erro, a carga de trabalho deve devolver um código de estado de erro HTTP apropriado (4xx, 5xx) com informação detalhada de erro no corpo da resposta.

Exemplos

Delete item example

Pedido de amostra

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

Resposta da amostra

Código de estado:: 200

Definições

Name	Description
DeleteType	O tipo de operação de eliminação.
ErrorExtendedInformation	A informação de erro alargada.
ErrorResponse	A resposta de erro.
ErrorSource	A origem do erro.
NameValuePair	Um par nome-valor.
OnDeleteItemRequest	Solicite corpo para eliminar um item.

DeleteType

Enumeração

O tipo de operação de eliminação.

Valor	Description
Hard	Uma operação de eliminação forçada.
Soft	Uma operação de apagamento suave.

ErrorExtendedInformation

Object

A informação de erro alargada.

Name	Tipo	Description
additionalParameters	NameValuePair[]	Uma lista de parâmetros adicionais específicos do erro.
errorCode	string	O código de erro.
message	string	A mensagem de erro.
messageParameters	string[]	Uma lista de parâmetros para formatar uma mensagem localizada.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
errorCode	string	O código de erro.
isPermanent	boolean	Indica se o erro é permanente ou se a operação pode ser tentada novamente.
message	string	A mensagem de erro.
messageParameters	string[]	Uma lista de parâmetros para formatar uma mensagem localizada.
moreDetails	ErrorExtendedInformation[]	Uma lista de detalhes adicionais sobre erros.
source	ErrorSource	A origem do erro.

ErrorSource

Enumeração

A origem do erro.

Valor	Description
System	O erro originou-se no sistema.
User	O erro originou-se a partir de uma entrada do utilizador.
External	O erro teve origem numa fonte externa.

NameValuePair

Object

Um par nome-valor.

Name	Tipo	Description
name	string	O nome.
value	string	O valor.

OnDeleteItemRequest

Object

Solicite corpo para eliminar um item.

Name	Tipo	Description
deleteType	DeleteType	O tipo de operação de eliminação.