Item Lifecycle - On Delete Item

Servicio:: Workload Development

Versión de la API:: v1

Llamado por Microsoft Fabric para eliminar un elemento existente.
Tras la eliminación de elementos, Fabric realiza validaciones básicas y llama a esta API para notificar a la carga de trabajo. Se espera que la carga de trabajo elimine los metadatos del elemento y los recursos gratuitos.

La solicitud incluye un valor deleteType de tipo que indica si la eliminación es Hard o Soft. Una eliminación temporal significa que el elemento se puede restaurar más adelante a través de la API OnRestoreItem, por lo que la carga de trabajo debe conservar suficientes metadatos y recursos para admitir la restauración. Una eliminación permanente es permanente y la carga de trabajo debe limpiar completamente todos los datos asociados.

Esta API debe aceptar la autenticación SubjectAndApp. Sin embargo, el token de asunto puede no estar disponible en algunos casos.

Permisos

Los permisos se comprueban mediante Microsoft Fabric.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
itemId	path	True	string (uuid)	Identificador del elemento.
itemType	path	True	string	Tipo de elemento.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
ActivityId	True	string (uuid)	Un identificador único para correlacionar la solicitud con el sistema cuando un usuario interactúa con la carga de trabajo.
RequestId	True	string (uuid)	Un identificador único global que ayuda a Fabric a correlacionar su solicitud con nuestros registros. Proporcione este identificador al notificar un problema.
Authorization	True	string	Encabezado de autorización de token dual que permite a la carga de trabajo validar el origen de la solicitud, proporcionar contexto de usuario y llamar a otros servicios. Este encabezado tiene el siguiente formato: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	Identificador de inquilino del cliente que realiza la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
deleteType	True	DeleteType	Tipo de operación de eliminación.

Respuestas

Nombre	Tipo	Description
200 OK		Eliminado con éxito.
Other Status Codes	ErrorResponse	Para las condiciones de error, la carga de trabajo debe devolver un código de estado de error HTTP adecuado (4xx, 5xx) con información detallada del error en el cuerpo de la respuesta.

Ejemplos

Delete item example

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 200

Definiciones

Nombre	Description
DeleteType	Tipo de operación de eliminación.
ErrorExtendedInformation	Información de error extendida.
ErrorResponse	Respuesta de error.
ErrorSource	Origen del error.
NameValuePair	Par nombre-valor.
OnDeleteItemRequest	Cuerpo de la solicitud para eliminar un elemento.

DeleteType

Enumeración

Tipo de operación de eliminación.

Valor	Description
Hard	Una operación de eliminación permanente.
Soft	Una operación de eliminación temporal.

ErrorExtendedInformation

Objeto

Información de error extendida.

Nombre	Tipo	Description
additionalParameters	NameValuePair[]	Lista de parámetros adicionales específicos del error.
errorCode	string	Código de error.
message	string	El mensaje de error.
messageParameters	string[]	Lista de parámetros para dar formato a un mensaje localizado.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Código de error.
isPermanent	boolean	Indica si el error es permanente o se puede reintentar la operación.
message	string	El mensaje de error.
messageParameters	string[]	Lista de parámetros para dar formato a un mensaje localizado.
moreDetails	ErrorExtendedInformation[]	Una lista de detalles de error adicionales.
source	ErrorSource	Origen del error.

ErrorSource

Enumeración

Origen del error.

Valor	Description
System	El error se originó en el sistema.
User	El error se originó en la entrada del usuario.
External	El error se originó en un origen externo.

NameValuePair

Objeto

Par nombre-valor.

Nombre	Tipo	Description
name	string	Nombre.
value	string	Valor de tipo .

OnDeleteItemRequest

Objeto

Cuerpo de la solicitud para eliminar un elemento.

Nombre	Tipo	Description
deleteType	DeleteType	Tipo de operación de eliminación.