Edit

Share via

Folders - Update Folder

Service:
Core
API Version:
v1

Updates the properties of 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 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

PATCH 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.

Request Body

Name Required Type Description
displayName True

string

The folder display name. The name must meet Folder name requirements

Responses

Name Type Description
200 OK

Folder

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

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

  • FolderDisplayNameAlreadyInUse - Folder display name is already used.

  • InvalidFolderDisplayName - The provided folder name is invalid, such as including invalid chars.

Examples

Update a folder example

Sample request

PATCH https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb

{
  "displayName": "A new Folder name"
}

Sample response

Status code:
200 
{
  "id": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb",
  "displayName": "A new Folder name",
  "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.
UpdateFolderRequest

Update 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.

UpdateFolderRequest

Object

Update folder request.

Name Type Description
displayName

string

The folder display name. The name must meet Folder name requirements