Delen via

Items - List Items

Service:
Core
API-versie:
v1

Retourneert een lijst met items uit de opgegeven werkruimte.
Deze API ondersteunt paginering.

Machtigingen

De aanroeper moet een werkruimterol voor de kijker hebben.

Vereiste gedelegeerde bereiken

Workspace.Read.All of Workspace.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit Steunen
Gebruiker Ja
service-principal en beheerde identiteiten Ja

gebruikersinterface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items
Met optionele parameters: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items?type={type}&recursive={recursive}&rootFolderId={rootFolderId}&continuationToken={continuationToken}

URI-parameters

Name In Vereist Type Description
workspaceId
 path True

string (uuid)

De werkruimte-id.
continuationToken
 query

string

Een token voor het ophalen van de volgende pagina met resultaten.
recursive
 query

boolean

Bevat items in een map en de geneste mappen, of alleen een map. Waar: alle items in de map en de geneste mappen worden weergegeven, Onwaar- Alleen items in de map worden vermeld. De standaardwaarde is waar.
rootFolderId
 query

string (uuid)

Met deze parameter kunnen gebruikers items filteren op basis van een specifieke hoofdmap. Als deze niet is opgegeven, wordt de werkruimte gebruikt als hoofdmap.
type
 query

string

Het type item.

Antwoorden

Name Type Description
200 OK

Items

De aanvraag is voltooid.
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • InvalidItemType - Ongeldig itemtype.

  • FolderNotFound - Kan de aangevraagde map niet vinden.

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
Item

Een itemobject.
Items
ItemTag

Vertegenwoordigt een tag die is toegepast op een item.
ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

Item

Object

Een itemobject.

Name Type Description
description

string

De beschrijving van het item.
displayName

string

De weergavenaam van het item.
folderId

string (uuid)

De map-id.
id

string (uuid)

De item-id.
tags

ItemTag[]

Lijst met toegepaste tags.
type

ItemType

Het itemtype.
workspaceId

string (uuid)

De werkruimte-id.

Items

Object
Name Type Description
continuationToken

string

Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri

string

De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value

Item[]

Een lijst met items.

ItemTag

Object

Vertegenwoordigt een tag die is toegepast op een item.

Name Type Description
displayName

string

De naam van de tag.
id

string (uuid)

De tag-id.

ItemType

Opsomming

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde Description
Dashboard

PowerBI-dashboard.
Report

PowerBI-rapport.
SemanticModel

Semantisch Power BI-model.
PaginatedReport

Gepagineerd Power BI-rapport.
Datamart

PowerBI-datamart.
Lakehouse

Een lakehouse.
Eventhouse

Een eventhouse.
Environment

Een omgeving.
KQLDatabase

Een KQL-database.
KQLQueryset

Een KQL-queryset.
KQLDashboard

Een KQL-dashboard.
DataPipeline

Een gegevenspijplijn.
Notebook

Een notitieblok.
SparkJobDefinition

Een Spark-taakdefinitie.
MLExperiment

Een machine learning-experiment.
MLModel

Een machine learning-model.
Warehouse

Een magazijn.
Eventstream

Een eventstream.
SQLEndpoint

Een SQL-eindpunt.
MirroredWarehouse

Een gespiegeld magazijn.
MirroredDatabase

Een gespiegelde database.
Reflex

Een reflex.
GraphQLApi

Een API voor GraphQL-item.
MountedDataFactory

Een MountedDataFactory.
SQLDatabase

Een SQLDatabase.
CopyJob

Een kopieertaak.
VariableLibrary

Een VariableLibrary.
Dataflow

Een gegevensstroom.
ApacheAirflowJob

Een ApacheAirflowJob.
WarehouseSnapshot

Een momentopname van een magazijn.
DigitalTwinBuilder

Een DigitalTwinBuilder.
DigitalTwinBuilderFlow

Een Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

Een gespiegelde Azure Databricks-catalogus.
Map

Een kaart.
AnomalyDetector

Een Anomaly Detector.
UserDataFunction

Een gebruikersgegevensfunctie.
GraphModel

Een GraphModel.
GraphQuerySet

Een Graph QuerySet.
SnowflakeDatabase

Een Snowflake-database voor het opslaan van Iceberg-tabellen die zijn gemaakt op basis van het Snowflake-account.
OperationsAgent

Een OperationsAgent.
CosmosDBDatabase

Een Cosmos DB-database.
Ontology

Een Ontologie.
EventSchemaSet

Een EventSchemaSet.