Folders - Get Folder

服务:

Core

API 版本:

v1

注释

此 API 处于预览状态。

返回指定文件夹的属性。

权限

调用方必须在工作区上具有 查看器 或更高版本的角色。

所需的委派范围

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

身份	支持
用户	是的
服务主体和托管标识	是的

接口

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

URI 参数

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

响应

名称	类型	说明
200 OK	Folder	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： FolderNotFound - 未在工作区中找到请求的文件夹。

示例

Get a folder example

示例请求

HTTP

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"
}

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
Folder	文件夹对象。

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。