Edit

Share via


Items - Move Item

Move the specified item to a folder within the same workspace. Child items are moved with their parent item. You can't move a child item without its parent item.

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}/items/{itemId}/move

URI Parameters

Name In Required Type Description
itemId
path True

string (uuid)

The item 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

MovedItems

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

  • ItemNotFound - The requested item was not found.

  • FolderNotFound - Could not find the requested folder.

  • CannotMoveChildOnly - Child item can't be moved without its parent item.

Examples

Move an item into folder example
Move an item with the workspace as the destination example

Move an item into folder example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items/cccccccc-2222-3333-4444-dddddddddddd/move

{
  "targetFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

Sample response

{
  "value": [
    {
      "id": "cccccccc-2222-3333-4444-dddddddddddd",
      "type": "Lakehouse",
      "displayName": "MyLakehouse",
      "description": "A lakehouse used by the sales team.",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    },
    {
      "id": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
      "type": "SQLEndpoint",
      "displayName": "MyLakehouse",
      "description": null,
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    }
  ]
}

Move an item with the workspace as the destination example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items/cccccccc-2222-3333-4444-dddddddddddd/move

{}

Sample response

{
  "value": [
    {
      "id": "cccccccc-2222-3333-4444-dddddddddddd",
      "type": "Lakehouse",
      "displayName": "MyLakehouse",
      "description": "A lakehouse used by the sales team.",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    },
    {
      "id": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
      "type": "SQLEndpoint",
      "displayName": "MyLakehouse",
      "description": null,
      "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.

Item

An item object.

ItemTag

Represents a tag applied on an item.

ItemType

The type of the item. Additional item types may be added over time.

MovedItems
MoveItemRequest

Move item request.

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.

Item

An item object.

Name Type Description
description

string

The item description.

displayName

string

The item display name.

folderId

string (uuid)

The folder ID.

id

string (uuid)

The item ID.

tags

ItemTag[]

List of applied tags.

type

ItemType

The item type.

workspaceId

string (uuid)

The workspace ID.

ItemTag

Represents a tag applied on an item.

Name Type Description
displayName

string

The name of the tag.

id

string (uuid)

The tag ID.

ItemType

The type of the item. Additional item types may be added over time.

Value Description
Dashboard

PowerBI dashboard.

Report

PowerBI report.

SemanticModel

PowerBI semantic model.

PaginatedReport

PowerBI paginated report.

Datamart

PowerBI datamart.

Lakehouse

A lakehouse.

Eventhouse

An eventhouse.

Environment

An environment.

KQLDatabase

A KQL database.

KQLQueryset

A KQL queryset.

KQLDashboard

A KQL dashboard.

DataPipeline

A data pipeline.

Notebook

A notebook.

SparkJobDefinition

A spark job definition.

MLExperiment

A machine learning experiment.

MLModel

A machine learning model.

Warehouse

A warehouse.

Eventstream

An eventstream.

SQLEndpoint

An SQL endpoint.

MirroredWarehouse

A mirrored warehouse.

MirroredDatabase

A mirrored database.

Reflex

A Reflex.

GraphQLApi

An API for GraphQL item.

MountedDataFactory

A MountedDataFactory.

SQLDatabase

A SQLDatabase.

CopyJob

A Copy job.

VariableLibrary

A VariableLibrary.

Dataflow

A Dataflow.

ApacheAirflowJob

An ApacheAirflowJob.

WarehouseSnapshot

A Warehouse snapshot.

DigitalTwinBuilder

A DigitalTwinBuilder.

DigitalTwinBuilderFlow

A Digital Twin Builder Flow.

MirroredAzureDatabricksCatalog

A mirrored azure databricks catalog.

Map

A Map.

AnomalyDetector

An Anomaly Detector.

UserDataFunction

A User Data Function.

GraphModel

A GraphModel.

GraphQuerySet

A Graph QuerySet.

SnowflakeDatabase

A Snowflake Database to store Iceberg tables created from Snowflake account.

OperationsAgent

A OperationsAgent.

CosmosDBDatabase

A Cosmos DB Database.

MovedItems

Name Type Description
value

Item[]

A list of items.

MoveItemRequest

Move item request.

Name Type Description
targetFolderId

string (uuid)

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