다음을 통해 공유


Folders - List Folders

지정된 작업 영역에서 폴더 목록을 반환합니다.

Note

이 API는 미리 보기 릴리스의 일부이며 평가 및 개발 목적으로만 제공됩니다. 피드백에 따라 변경 될 수 있으며 프로덕션 사용에는 권장되지 않습니다.

이 API는 페이지 매김지원합니다.

Permissions

호출자에게는 뷰어 이상의 작업 영역 역할이 있어야 합니다.

필요한 위임된 범위

Workspace.Read.All 또는 Workspace.ReadWrite.All

Microsoft Entra 지원 ID

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

Identity Support
User Yes
서비스 주체관리 ID Yes

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/folders
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/folders?rootFolderId={rootFolderId}&recursive={recursive}&continuationToken={continuationToken}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
workspaceId
path True

string (uuid)

작업 영역 ID입니다.

continuationToken
query

string

결과의 다음 페이지를 검색하기 위한 토큰입니다.

recursive
query

boolean

폴더의 폴더와 해당 중첩 폴더 또는 폴더만 나열합니다. True - 폴더의 모든 폴더와 해당 중첩된 폴더가 나열되고 False - 폴더의 폴더만 나열됩니다. 기본값은 true입니다.

rootFolderId
query

string (uuid)

이 매개 변수를 사용하면 사용자가 특정 루트 폴더를 기반으로 폴더를 필터링할 수 있습니다. 제공되지 않으면 작업 영역이 루트 폴더로 사용됩니다.

응답

Name 형식 Description
200 OK

Folders

요청이 성공적으로 완료되었습니다.

Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • FolderNotFound - 요청된 폴더를 찾을 수 없습니다.

예제

List all folders in workspace example
List all folders in workspace with continuation example
List direct children folders under parent folder example
List folders under parent folder recursively example

List all folders in workspace example

샘플 요청

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

샘플 응답

{
  "value": [
    {
      "id": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb",
      "displayName": "Sales",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    },
    {
      "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
      "displayName": "Y2024",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb"
    },
    {
      "id": "cccccccc-8888-9999-0000-dddddddddddd",
      "displayName": "Q1",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    },
    {
      "id": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
      "displayName": "Q2",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    }
  ]
}

List all folders in workspace with continuation example

샘플 요청

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

샘플 응답

{
  "value": [
    {
      "id": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb",
      "displayName": "Sales",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    },
    {
      "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
      "displayName": "Y2024",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb"
    },
    {
      "id": "cccccccc-8888-9999-0000-dddddddddddd",
      "displayName": "Q1",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    },
    {
      "id": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
      "displayName": "Q2",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    }
  ],
  "continuationToken": "MAEsMTbwMDAwLDA%5D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders?continuationToken=MAEsMTbwMDAwLDA%5D"
}

List direct children folders under parent folder example

샘플 요청

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders?rootFolderId=aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb&recursive=False

샘플 응답

{
  "value": [
    {
      "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
      "displayName": "Y2024",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb"
    }
  ]
}

List folders under parent folder recursively example

샘플 요청

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders?rootFolderId=aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb&recursive=True

샘플 응답

{
  "value": [
    {
      "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
      "displayName": "Y2024",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb"
    },
    {
      "id": "cccccccc-8888-9999-0000-dddddddddddd",
      "displayName": "Q1",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    },
    {
      "id": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
      "displayName": "Q2",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    }
  ]
}

정의

Name Description
ErrorRelatedResource

오류 관련 리소스 세부 정보 개체입니다.

ErrorResponse

오류 응답입니다.

ErrorResponseDetails

오류 응답 세부 정보입니다.

Folder

폴더 개체입니다.

Folders

ErrorRelatedResource

오류 관련 리소스 세부 정보 개체입니다.

Name 형식 Description
resourceId

string

오류와 관련된 리소스 ID입니다.

resourceType

string

오류와 관련된 리소스의 형식입니다.

ErrorResponse

오류 응답입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.

message

string

사용자가 읽을 수 있는 오류 표현입니다.

moreDetails

ErrorResponseDetails[]

추가 오류 세부 정보 목록입니다.

relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.

requestId

string

오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

오류 응답 세부 정보입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.

message

string

사용자가 읽을 수 있는 오류 표현입니다.

relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.

Folder

폴더 개체입니다.

Name 형식 Description
displayName

string

폴더 표시 이름입니다.

id

string (uuid)

폴더 ID입니다.

parentFolderId

string (uuid)

부모 폴더 ID입니다. 부모 폴더가 작업 영역인 경우 parentFolderId 지정되지 않았거나 null입니다.

workspaceId

string (uuid)

작업 영역 ID입니다.

Folders

Name 형식 Description
continuationToken

string

다음 결과 집합 일괄 처리에 대한 토큰입니다. 레코드가 더 이상 없으면 응답에서 제거됩니다.

continuationUri

string

다음 결과 집합 일괄 처리의 URI입니다. 레코드가 더 이상 없으면 응답에서 제거됩니다.

value

Folder[]

폴더 목록입니다.