Edit

Share via

Folders - Move Folder

Service:
Core
API Version:
v1

Moves the specified folder within the same workspace.

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 role on the workspace.

Required Delegated Scopes

Workspace.ReadWrite.All

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

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

URI Parameters

Name In Required Type Description
folderId
 path True

string (uuid)

The folder ID.
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Type Description
targetFolderId

string (uuid)

The destination folder ID. If not provided, the workspace is used as the destination folder.

Responses

Name Type Description
200 OK

Folder

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • FolderNotFound - Could not find the requested folder.

  • FolderDepthOutOfRange - The parent folder has achieved max depth, can't create a new subfolder.

  • InfiniteFolderHierarchyLoop - The folder can't be moved into any of its descents.

  • FolderDisplayNameAlreadyInUse - Folder display name is already used.

Examples

Move a folder into another folder example
Move a folder with the workspace as the destination example

Move a folder into another folder example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/dddddddd-9999-0000-1111-eeeeeeeeeeee/move

{
  "targetFolderId": "cccccccc-8888-9999-0000-dddddddddddd"
}

Sample response

Status code:
200 
{
  "id": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
  "displayName": "Q2",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "parentFolderId": "cccccccc-8888-9999-0000-dddddddddddd"
}

Move a folder with the workspace as the destination example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/dddddddd-9999-0000-1111-eeeeeeeeeeee/move

{}

Sample response

Status code:
200 
{
  "id": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
  "displayName": "Q2",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
Folder

A folder object.
MoveFolderRequest

Move folder request.

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

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.

Folder

Object

A folder object.

Name Type Description
displayName

string

The folder display name.
id

string (uuid)

The folder ID.
parentFolderId

string (uuid)

The parent folder ID. If the parent folder is a workspace, parentFolderId is either not specified or null.
workspaceId

string (uuid)

The workspace ID.

MoveFolderRequest

Object

Move folder request.

Name Type Description
targetFolderId

string (uuid)

The destination folder ID. If not provided, the workspace is used as the destination folder.