Edit

Share via

Items - Delete Item

Service:
Core
API Version:
v1

Deletes the specified item.
This API is supported for a number of item types, find the supported item types and information about their definition structure in Item management overview. The default behavior is to soft delete the item for supported item types.

Note

The soft-deleted items will be counted toward the maximum number of items allowed in each workspace.

Permissions

The caller must have write permissions for the item for soft deletion. The caller must have workspace Admin role assigned for hard/permanent deletion.

Required Delegated Scopes

For item APIs use these scope types:

  • Generic scope: Item.ReadWrite.All
  • Specific scope: itemType.ReadWrite.All (for example: Notebook.ReadWrite.All)

for more information about scopes, see scopes article.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported.

Interface

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

URI Parameters

Name In Required Type Description
itemId
 path True

string (uuid)

The item ID.
workspaceId
 path True

string (uuid)

The workspace ID.
hardDelete
 query

boolean

Specifies whether to perform a hard delete. When set to true, the item is permanently deleted and cannot be recovered. When set to false or not specified, the item is soft-deleted if the item type supports it.

Responses

Name Type Description
200 OK

Request completed successfully.
429 Too Many Requests

ErrorResponse

The service rate limit was exceeded. The server returns a Retry-After header indicating, in seconds, how long the client must wait before sending additional requests.

Headers

Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • ItemNotFound - The requested item was not found.

  • InsufficientWorkspaceRole - User doesn't have sufficient workspace role.

  • FeatureNotAvailable - This could be due to the soft deletion feature not being available.

  • UnsupportedItemType - This could be due to the soft deletion feature not supported by the requested item type.

  • TenantSwitchDisabled - This could be due to the soft deletion feature being disabled by the tenant admin.

  • InvalidTargetItemStateForSoftDeletion - The item is in invalid states for soft deletion.

  • InvalidParentItemStateForSoftDeletion - The item's parent item is not in Active state.

Examples

Delete an item example
Hard delete an item example

Delete an item example

Sample request

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

Sample response

Status code:
200

Hard delete an item example

Sample request

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

Sample response

Status code:
200

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string (uuid)

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.