Folders - Create Folder

服务:

Core

API 版本:

v1

在指定的工作区中创建一个文件夹。

Note

此 API 是预览版的一部分，仅用于评估和开发目的。 它可能会根据反馈进行更改，不建议将其用于生产。

Permissions

调用方必须具有 参与者 或更高版本的工作区角色。

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity	Support
User	Yes
服务主体和托管标识	Yes

Interface

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

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string (uuid)	工作区 ID。

请求正文

名称	必需	类型	说明
displayName	True	string	文件夹显示名称。 该名称必须满足 文件夹名称要求
parentFolderId		string (uuid)	父文件夹 ID。 如果未指定或为 null，则会使用工作区作为其父文件夹创建该文件夹。

响应

名称	类型	说明
201 Created	Folder	已成功创建
Other Status Codes	ErrorResponse	常见错误代码： FolderDisplayNameAlreadyInUse - 已使用文件夹显示名称。 FolderNotFound - 未在工作区中找到请求的文件夹。 InvalidFolderDisplayName - 提供的文件夹显示名称无效。 FolderDepthOutOfRange - 父文件夹已达到最大深度，无法创建新的子文件夹。 WorkspaceNotSupported - 指定的工作区类型不支持 Folder .* TooManyFolders - 指定的工作区已达到文件夹的最大计数，无法再创建任何文件夹。

示例

Create a folder under another folder example

Create a folder with the workspace as its parent folder example

Create a folder under another folder example

示例请求

HTTP

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

{
  "displayName": "Q3",
  "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

示例响应

状态代码:

201

{
  "id": "ffffffff-5555-6666-7777-aaaaaaaaaaaa",
  "displayName": "Q3",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

Create a folder with the workspace as its parent folder example

示例请求

HTTP

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

{
  "displayName": "A folder"
}

示例响应

状态代码:

201

{
  "id": "eeeeeeee-4444-5555-6666-ffffffffffff",
  "displayName": "A folder",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
}

定义

名称	说明
CreateFolderRequest	创建文件夹请求有效负载。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
Folder	文件夹对象。

CreateFolderRequest

Object

创建文件夹请求有效负载。

名称	类型	说明
displayName	string	文件夹显示名称。 该名称必须满足 文件夹名称要求
parentFolderId	string (uuid)	父文件夹 ID。 如果未指定或为 null，则会使用工作区作为其父文件夹创建该文件夹。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

Folder

Object

文件夹对象。

名称	类型	说明
displayName	string	文件夹显示名称。
id	string (uuid)	文件夹 ID。
parentFolderId	string (uuid)	父文件夹 ID。 如果父文件夹是工作区，则 parentFolderId 未指定或为 null。
workspaceId	string (uuid)	工作区 ID。