Items - Delete Item

Servicio:
Core
Versión de la API:
v1

Elimina el elemento especificado.
Esta API se admite para varios tipos de elementos, busque los tipos de elementos admitidos e información sobre su estructura de definición en Información general de administración de elementos. El comportamiento predeterminado es eliminar temporalmente el elemento para los tipos de elementos admitidos.

Nota:

Los elementos eliminados temporalmente se contarán para el número máximo de elementos permitidos en cada área de trabajo.

Permisos

El autor de la llamada debe tener permisos de escritura para el elemento para su eliminación temporal. El autor de la llamada debe tener asignado el rol administrador del área de trabajo para la eliminación permanente o dura.

Ámbitos delegados necesarios

Para las API de elementos, use estos tipos de ámbito:

  • Ámbito genérico: Item.ReadWrite.All
  • Ámbito específico: itemType. ReadWrite.All (por ejemplo: Notebook.ReadWrite.All)

para obtener más información sobre los ámbitos, consulte artículo sobre ámbitos.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad Apoyo
Usuario Sí
Entidad de servicio e Identidades administradas Cuando se admite el tipo de elemento en la llamada. Compruebe la API correspondiente para el tipo de elemento al que llama, para ver si se admite la llamada. Por ejemplo, se admiten modelos semánticos.

Interfaz

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}
Con parámetros opcionales: 
DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}?hardDelete={hardDelete}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
itemId
 path True

string (uuid)

Identificador del elemento.
workspaceId
 path True

string (uuid)

El identificador del área de trabajo.
hardDelete
 query

boolean

Especifica si se va a realizar una eliminación permanente. Cuando se establece en true, el elemento se elimina permanentemente y no se puede recuperar. Cuando se establece en false o no se especifica, el elemento se elimina temporalmente si el tipo de elemento lo admite.

Respuestas

Nombre Tipo Description
200 OK

Solicitud completada correctamente.
429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • ItemNotFound: no se encontró el elemento solicitado.

  • InsuficienteWorkspaceRole: el usuario no tiene suficiente rol de área de trabajo.

  • FeatureNotAvailable: esto podría deberse a que la característica de eliminación temporal no está disponible.

  • UnsupportedItemType: esto podría deberse a la característica de eliminación temporal no compatible con el tipo de elemento solicitado.

  • TenantSwitchDisabled: esto podría deberse a que el administrador de inquilinos deshabilita la característica de eliminación temporal.

  • InvalidTargetItemStateForSoftDeletion: el elemento está en estados no válidos para la eliminación temporal.

  • InvalidParentItemStateForSoftDeletion: el elemento primario del elemento no está en estado Activo.

Ejemplos

Delete an item example
Hard delete an item example

Delete an item example

Solicitud de ejemplo

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715

Respuesta de muestra

status code:
200

Hard delete an item example

Solicitud de ejemplo

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715?hardDelete=True

Respuesta de muestra

status code:
200

Definiciones

Nombre Description
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string (uuid)

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.