Folders - Get Folder

服務:
Core
API 版本:
v1

傳回指定資料夾的屬性。

Note

此 API 是預覽版的一部分，僅供評估和開發之用。 它可能會根據意見反應而變更，不建議用於生產環境。

Permissions

呼叫端在工作區上必須具有 查看器 或更高角色。

必要的委派範圍

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別。

Identity Support
User Yes
服務主體 和 受控識別 Yes

Interface

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

URI 參數

名稱 位於 必要 類型 Description
folderId
 path True

string (uuid)

資料夾識別碼。
workspaceId
 path True

string (uuid)

工作區標識碼。

回覆

名稱 類型 Description
200 OK

Folder

要求成功完成。
429 Too Many Requests

ErrorResponse

服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。

標題

Retry-After: integer
Other Status Codes

ErrorResponse

常見的錯誤碼：

  • FolderNotFound - 工作區中找不到要求的資料夾。

範例

Get a folder example

範例要求

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/bbbbbbbb-1111-2222-3333-cccccccccccc

範例回覆

狀態碼:
200 
{
  "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
  "displayName": "A nested folder",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "parentFolderId": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb"
}

定義

名稱 Description
ErrorParameter

一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource

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

錯誤回應。
ErrorResponseDetails

錯誤回應詳細數據。
Folder

資料夾物件。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱 類型 Description
message

string

一個人類可讀的參數意義描述。
name

string

參數識別碼。
value

string

這是參數值。

ErrorRelatedResource

Object

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

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable

boolean

若屬實，請求可重新嘗試。 如果有延遲，請使用 Retry-After 回應標頭來判斷延遲。
message

string

錯誤的人類可讀取表示法。
moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。
parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。
requestId

string (uuid)

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

Folder

Object

資料夾物件。

名稱 類型 Description
displayName

string

資料夾顯示名稱。
id

string (uuid)

資料夾識別碼。
parentFolderId

string (uuid)

父資料夾識別碼。 如果父資料夾是工作區，則 parentFolderId 未指定或 null。
workspaceId

string (uuid)

工作區標識碼。