Edit

Share via


Folders - Delete Folder

Deletes the specified folder.

Note

This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

Workspace.ReadWrite.All

Limitations

  • This API is supported only for the empty folder. Deleting a folder with any items or nested folders inside is not allowed, and returns a FolderNotEmpty error response.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/folders/{folderId}

URI Parameters

Name In Required Type Description
folderId
path True

string (uuid)

The folder ID.

workspaceId
path True

string (uuid)

The workspace ID.

Responses

Name Type Description
200 OK

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

  • FolderNotFound - The requested folder was not found in the workspace.

  • FolderNotEmpty - The requested folder was not empty.

Examples

Delete a folder example

Sample request

DELETE https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/bbbbbbbb-1111-2222-3333-cccccccccccc

Sample response

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.