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 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string (uuid)	工作區標識碼。

要求本文

名稱	必要	類型	Description
displayName	True	string	資料夾顯示名稱。 名稱必須符合資料夾名稱需求
parentFolderId		string (uuid)	父資料夾識別碼。 如果未指定 或 null，則會使用工作區作為其父資料夾來建立資料夾。

回應

名稱	類型	Description
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"
}

定義

名稱	Description
CreateFolderRequest	建立資料夾要求承載。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
Folder	資料夾物件。

CreateFolderRequest

Object

建立資料夾要求承載。

名稱	類型	Description
displayName	string	資料夾顯示名稱。 名稱必須符合資料夾名稱需求
parentFolderId	string (uuid)	父資料夾識別碼。 如果未指定 或 null，則會使用工作區作為其父資料夾來建立資料夾。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

Folder

Object

資料夾物件。

名稱	類型	Description
displayName	string	資料夾顯示名稱。
id	string (uuid)	資料夾識別碼。
parentFolderId	string (uuid)	父資料夾識別碼。 如果父資料夾是工作區，則 parentFolderId 未指定或 null。
workspaceId	string (uuid)	工作區標識碼。