Udostępnij przez

Folders - List Folders

Usługa:
Core
Wersja interfejsu API:
v1

Zwraca listę folderów z określonego obszaru roboczego.

Note

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Ten interfejs API obsługuje stronicowanie.

Permissions

Obiekt wywołujący musi mieć lub większą rolę obszaru roboczego.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

Tożsamości obsługiwane przez firmę Microsoft

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.
continuationToken
 query

string

Token do pobierania następnej strony wyników.
recursive
 query

boolean

Wyświetla listę folderów w folderze i jego folderach zagnieżdżonych lub tylko folder. True — wszystkie foldery w folderze i jego foldery zagnieżdżone są wymienione na liście Fałsz — są wyświetlane tylko foldery w folderze. Wartość domyślna to true.
rootFolderId
 query

string (uuid)

Ten parametr umożliwia użytkownikom filtrowanie folderów na podstawie określonego folderu głównego. Jeśli nie zostanie podany, obszar roboczy będzie używany jako folder główny.

Odpowiedzi

Nazwa Typ Opis
200 OK

Folders

Żądanie zostało ukończone pomyślnie.
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • FolderNotFound — nie można odnaleźć żądanego folderu.

Przykłady

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "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"
    }
  ]
}

Definicje

Nazwa Opis
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
Folder

Obiekt folderu.
Folders

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

Folder

Objekt

Obiekt folderu.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana folderu.
id

string (uuid)

Identyfikator folderu.
parentFolderId

string (uuid)

Identyfikator folderu nadrzędnego. Jeśli folder nadrzędny jest obszarem roboczym, parentFolderId nie jest określony lub ma wartość null.
workspaceId

string (uuid)

Identyfikator obszaru roboczego.

Folders

Objekt
Nazwa Typ Opis
continuationToken

string

Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri

string

Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
value

Folder[]

Lista folderów.