Freigeben über


Items - List Items

Gibt eine Liste von Elementen aus dem angegebenen Arbeitsbereich zurück.
Diese API unterstützt Paginierung.

Erlaubnisse

Der Aufrufer muss über eine Rolle des Viewer-Arbeitsbereichs verfügen.

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.

Identität Unterstützen
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items?type={type}&recursive={recursive}&rootFolderId={rootFolderId}&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 Elemente in einem Ordner und seinen geschachtelten Ordnern oder nur einen Ordner auf. True – Alle Elemente im Ordner und die zugehörigen geschachtelten Ordner werden aufgelistet, False – Nur Elemente im Ordner werden aufgelistet. Der Standardwert ist „wahr“.

rootFolderId
query

string (uuid)

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

type
query

string

Der Elementtyp.

Antworten

Name Typ Beschreibung
200 OK

Items

Die Anforderung wurde erfolgreich abgeschlossen.

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • InvalidItemType – Ungültiger Elementtyp.

  • FolderNotFound – Der angeforderte Ordner konnte nicht gefunden werden.

Beispiele

List all items in a specific folder example
List all items in workspace by type query parameter example
List all items in workspace example
List direct items in a specific folder example
List direct items in workspace example
List items in workspace with continuation example

List all items in a specific folder example

Beispielanforderung

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

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "cccccccc-2222-3333-4444-dddddddddddd",
      "displayName": "Lakehouse",
      "description": "A lakehouse used by the sales team.",
      "type": "Lakehouse",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    },
    {
      "id": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
      "displayName": "Notebook",
      "description": "A notebook for refining Q1 of year 2024 sales data analysis through machine learning algorithms.",
      "type": "Notebook",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "cccccccc-8888-9999-0000-dddddddddddd"
    }
  ]
}

List all items in workspace by type query parameter example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items?type=Lakehouse

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Lakehouse Name 1",
      "description": "A lakehouse used by the analytics team.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

List all items in workspace example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Lakehouse",
      "description": "A lakehouse used by the analytics team.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    },
    {
      "id": "58fa1eac-9694-4a6b-ba25-3520288e8fea",
      "displayName": "Notebook",
      "description": "A notebook for refining medical data analysis through machine learning algorithms.",
      "type": "KustoDashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

List direct items in a specific folder example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items?recursive=False&rootFolderId=bbbbbbbb-1111-2222-3333-cccccccccccc

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
      "displayName": "Notebook",
      "description": "A notebook for refining year 2024 sales data analysis through machine learning algorithms.",
      "type": "Notebook",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    }
  ]
}

List direct items in workspace example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items?recursive=False

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "cccccccc-2222-3333-4444-dddddddddddd",
      "displayName": "Lakehouse",
      "description": "A lakehouse shared by the all teams.",
      "type": "Lakehouse",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    }
  ]
}

List items in workspace with continuation example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Lakehouse",
      "description": "A lakehouse used by the analytics team.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    },
    {
      "id": "58fa1eac-9694-4a6b-ba25-3520288e8fea",
      "displayName": "Notebook",
      "description": "A notebook for refining medical data analysis through machine learning algorithms.",
      "type": "KustoDashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.

ErrorResponse

Die Fehlerantwort.

ErrorResponseDetails

Die Fehlerantwortdetails.

Item

Ein Elementobjekt.

Items
ItemTag

Stellt ein Tag dar, das auf ein Element angewendet wird.

ItemType

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

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

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

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.

Item

Ein Elementobjekt.

Name Typ Beschreibung
description

string

Die Elementbeschreibung.

displayName

string

Der Anzeigename des Elements.

folderId

string (uuid)

Die Ordner-ID.

id

string (uuid)

Die Element-ID.

tags

ItemTag[]

Liste der angewendeten Tags.

type

ItemType

Der Elementtyp.

workspaceId

string (uuid)

Die Arbeitsbereichs-ID.

Items

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

Item[]

Eine Liste von Elementen.

ItemTag

Stellt ein Tag dar, das auf ein Element angewendet wird.

Name Typ Beschreibung
displayName

string

Der Name des Tags.

id

string (uuid)

Die Tag-ID.

ItemType

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Dashboard

PowerBI-Dashboard.

Report

PowerBI-Bericht.

SemanticModel

PowerBI-Semantikmodell.

PaginatedReport

PowerBI-Paginated-Bericht.

Datamart

PowerBI datamart.

Lakehouse

Ein Seehaus.

Eventhouse

Ein Eventhouse.

Environment

Eine Umgebung.

KQLDatabase

Eine KQL-Datenbank.

KQLQueryset

Ein KQL-Abfrageset.

KQLDashboard

Ein KQL-Dashboard.

DataPipeline

Eine Datenpipeline.

Notebook

Ein Notizbuch.

SparkJobDefinition

Eine Sparkauftragsdefinition.

MLExperiment

Ein Machine Learning-Experiment.

MLModel

Ein Machine Learning-Modell.

Warehouse

Ein Lagerhaus.

Eventstream

Ein Ereignisstream.

SQLEndpoint

Ein SQL-Endpunkt.

MirroredWarehouse

Ein gespiegeltes Lager.

MirroredDatabase

Eine gespiegelte Datenbank.

Reflex

Ein Reflex.

GraphQLApi

Eine API für GraphQL-Element.

MountedDataFactory

Eine MountedDataFactory.

SQLDatabase

Eine SQLDatabase.

CopyJob

Ein Kopierauftrag.

VariableLibrary

Eine VariableLibrary.

Dataflow

Ein Datenfluss.

ApacheAirflowJob

Ein ApacheAirflowJob.

WarehouseSnapshot

Eine Warehouse-Momentaufnahme.

DigitalTwinBuilder

Ein DigitalTwinBuilder.

DigitalTwinBuilderFlow

Ein Digital Twin Builder Flow.

MirroredAzureDatabricksCatalog

Ein gespiegelter Azure Databricks-Katalog.

Map

Eine Karte.

AnomalyDetector

Anomaliedetektor.

UserDataFunction

Eine Benutzerdatenfunktion.

GraphModel

Ein GraphModel.

GraphQuerySet

Ein Graph QuerySet.

SnowflakeDatabase

Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.

OperationsAgent

Ein OperationsAgent.

CosmosDBDatabase

Eine Cosmos DB-Datenbank.

Ontology

Eine Ontologie.

EventSchemaSet

Ein EventSchemaSet.