Edit

Share via

OneLake Shortcuts - Delete Shortcut

  • Reference
Service:
Core
API Version:
v1

Deletes the shortcut but does not delete the destination storage folder.

Required Delegated Scopes

OneLake.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal Yes
Managed identities Yes

Interface

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts/{shortcutPath}/{shortcutName}

URI Parameters

Name In Required Type Description
itemId
 path True

string

uuid

The ID of the data item.
shortcutName
 path True

string

The name of the shortcut to delete. For more information see: Directory and file names.
shortcutPath
 path True

string

The path of the shortcut to be deleted. For more information see: Directory and file names.
workspaceId
 path True

string

uuid

The ID of the workspace.

Responses

Name Type Description
200 OK

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • ItemNotFound - Server cannot find the requested item.

  • UnknownError - An error occurred.

Examples

Delete shortcut One Lake target example

Sample request

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcut

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

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

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

ID of the request associated with the error.

ErrorResponseDetails

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.