Freigeben über

Folders - List Folders

Dienst:
Core
API-Version:
v1

Gibt eine Liste von Ordnern aus dem angegebenen Arbeitsbereich zurück.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Diese API unterstützt Paginierung.

Permissions

Der Anrufer muss Viewer-rolle oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
User Yes
Service Principal und Verwaltete Identitäten Yes

Interface

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
continuationToken
 query

string

Ein Token zum Abrufen der nächsten Seite mit Ergebnissen.
recursive
 query

boolean

Listet Ordner in einem Ordner und seinen geschachtelten Ordnern oder nur einen Ordner auf. True – Alle Ordner im Ordner und die zugehörigen geschachtelten Ordner werden aufgelistet, False – Nur Ordner im Ordner werden aufgelistet. Der Standardwert ist „wahr“.
rootFolderId
 query

string (uuid)

Mit diesem Parameter können Benutzer Ordner basierend auf einem bestimmten Stammordner filtern. Wenn nicht angegeben, wird der Arbeitsbereich als Stammordner verwendet.

Antworten

Name Typ Beschreibung
200 OK

Folders

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • FolderNotFound – Der angeforderte Ordner konnte nicht gefunden werden.

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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"
    }
  ]
}

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
Folder

Ein Ordnerobjekt.
Folders

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

Folder

Objekt

Ein Ordnerobjekt.

Name Typ Beschreibung
displayName

string

Der Anzeigename des Ordners.
id

string (uuid)

Die Ordner-ID.
parentFolderId

string (uuid)

Die id des übergeordneten Ordners. Wenn der übergeordnete Ordner ein Arbeitsbereich ist, wird parentFolderId entweder nicht angegeben oder null.
workspaceId

string (uuid)

Die Arbeitsbereichs-ID.

Folders

Objekt
Name Typ Beschreibung
continuationToken

string

Das Token für den nächsten Resultsetbatch. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
continuationUri

string

Der URI des nächsten Resultsetbatches. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
value

Folder[]

Eine Liste von Ordnern.