Items - Delete Item

Удаляет указанный элемент.
Этот API поддерживается для ряда типов элементов, найдите поддерживаемые типы элементов и сведения о структуре их определения в обзоре управления элементами. Поведение по умолчанию — обратимое удаление элемента для поддерживаемых типов элементов.

Замечание

Обратимо удаленные элементы будут подсчитываться до максимального числа элементов, разрешенных в каждой рабочей области.

Разрешения

Вызывающий объект должен иметь разрешения на запись для элемента для обратимого удаления. Вызывающий объект должен иметь роль администратора рабочей области, назначенную для жесткого или постоянного удаления.

Обязательные делегированные области

Для API элементов используются следующие типы областей:

  • Универсальная область: Item.ReadWrite.All
  • Конкретная область: itemType. ReadWrite.All (например: Notebook.ReadWrite.All)

Дополнительные сведения об областях см. в статье области.

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность Поддержка
Пользователь Да
Представитель службы и управляемые удостоверения Если тип элемента в вызове поддерживается. Проверьте соответствующий API для вызываемого типа элемента, чтобы узнать, поддерживается ли ваш вызов. Например, поддерживаются семантические модели.

Интерфейс

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}
DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}?hardDelete={hardDelete}

Параметры URI

Имя В Обязательно Тип Описание
itemId
path True

string (uuid)

Идентификатор элемента.

workspaceId
path True

string (uuid)

Идентификатор рабочей области.

hardDelete
query

boolean

Указывает, следует ли выполнять жесткое удаление. Если задано значение true, элемент удаляется безвозвратно и не может быть восстановлен. Если задано false значение или не указано, элемент обратимо удаляется, если тип элемента поддерживает его.

Ответы

Имя Тип Описание
200 OK

Запрос успешно завершен.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • ItemNotFound — запрошенный элемент не найден.

  • InsufficientWorkspaceRole — пользователь не имеет достаточной роли рабочей области.

  • FeatureNotAvailable — это может быть связано с тем, что функция обратимого удаления недоступна.

  • UnsupportedItemType — это может быть связано с функцией обратимого удаления, которая не поддерживается запрошенным типом элемента.

  • TenantSwitchDisabled . Это может быть связано с функцией обратимого удаления, отключаемой администратором клиента.

  • InvalidTargetItemStateForSoftDeletion — элемент находится в недопустимых состояниях для обратимого удаления.

  • InvalidParentItemStateForSoftDeletion — родительский элемент элемента не находится в активном состоянии.

Примеры

Delete an item example
Hard delete an item example

Delete an item example

Образец запроса

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

Пример ответа

Hard delete an item example

Образец запроса

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

Пример ответа

Определения

Имя Описание
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.

ErrorResponse

Ответ на ошибку.

ErrorResponseDetails

Сведения об ответе на ошибку.

ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.

resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.

message

string

Удобочитаемое представление ошибки.

moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.

relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.

message

string

Удобочитаемое представление ошибки.

relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.