Item Lifecycle - On Delete Item

Serviço:: Workload Development

Versão da API:: v1

Chamado por Microsoft Fabric para excluir um item existente.
Após a exclusão de item, o Fabric executa validações básicas e chama essa API para notificar a carga de trabalho. Espera-se que a carga de trabalho exclua os metadados do item e os recursos gratuitos.

A solicitação inclui uma deleteType indicação se a exclusão é Hard ou Soft. Uma exclusão reversível significa que o item pode ser restaurado posteriormente por meio da API OnRestoreItem, portanto, a carga de trabalho deve manter metadados e recursos suficientes para dar suporte à restauração. Uma exclusão temporária é permanente e a carga de trabalho deve limpar totalmente todos os dados associados.

Essa API deve aceitar a autenticação SubjectAndApp. No entanto, o token de assunto pode estar indisponível em alguns casos.

Permissões

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
itemId	path	True	string (uuid)	A ID do item.
itemType	path	True	string	O tipo de item.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
ActivityId	True	string (uuid)	Uma ID exclusiva para correlacionar a solicitação com seu sistema quando um usuário interage com sua carga de trabalho.
RequestId	True	string (uuid)	Uma ID global exclusiva que ajuda o Fabric a correlacionar sua solicitação com nossos logs. Forneça essa ID ao relatar um problema.
Authorization	True	string	Um cabeçalho de autorização de token duplo que permite que a carga de trabalho valide a origem da solicitação, forneça o contexto do usuário e chame outros serviços. Esse cabeçalho tem o seguinte formato: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	A ID do locatário do cliente que está fazendo a solicitação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
deleteType	True	DeleteType	O tipo de operação de exclusão.

Respostas

Nome	Tipo	Description
200 OK		Excluído com sucesso.
Other Status Codes	ErrorResponse	Para condições de erro, a carga de trabalho deve retornar um código de status de erro HTTP apropriado (4xx, 5xx) com informações detalhadas de erro no corpo da resposta.

Exemplos

Delete item example

Solicitação de exemplo

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 de exemplo

Código de status:: 200

Definições

Nome	Description
DeleteType	O tipo de operação de exclusão.
ErrorExtendedInformation	As informações de erro estendidas.
ErrorResponse	A resposta de erro.
ErrorSource	A origem do erro.
NameValuePair	Um par nome-valor.
OnDeleteItemRequest	Corpo da solicitação para excluir um item.

DeleteType

Enumeração

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

Valor	Description
Hard	Uma operação de exclusão rígida.
Soft	Uma operação de exclusão reversível.

ErrorExtendedInformation

Objeto

As informações de erro estendidas.

Nome	Tipo	Description
additionalParameters	NameValuePair[]	Uma lista de parâmetros adicionais específicos ao 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

Objeto

A resposta de erro.

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

ErrorSource

Enumeração

A origem do erro.

Valor	Description
System	O erro se originou do sistema.
User	O erro se originou da entrada do usuário.
External	O erro se originou de uma origem externa.

NameValuePair

Objeto

Um par nome-valor.

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

OnDeleteItemRequest

Objeto

Corpo da solicitação para excluir um item.

Nome	Tipo	Description
deleteType	DeleteType	O tipo de operação de exclusão.