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

Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft identities die in deze sectie worden vermeld.

Identiteit Steunen
Gebruiker Ja
serviceprincipal 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}&include=DefaultIdentity

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.
include
 query

ItemIncludeOption[]

Hiermee geeft u op welke itemeigenschappen in het antwoord moeten worden opgenomen als een door komma's gescheiden lijst. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.
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.
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
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 items with include option 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&include=DefaultIdentity

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&include=DefaultIdentity

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?include=DefaultIdentity

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&include=DefaultIdentity

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&include=DefaultIdentity

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?include=DefaultIdentity

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"
}

List items with include option example

Voorbeeldaanvraag

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

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",
      "defaultIdentity": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      }
    },
    {
      "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",
      "defaultIdentity": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      }
    }
  ]
}

Definities

Name Description
EntireTenantPrincipal

Vertegenwoordigt een tenant-principal
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
GroupDetails

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.
GroupPrincipal

Vertegenwoordigt een beveiligingsgroep.
GroupType

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.
Item

Een itemobject.
ItemIncludeOption

Hiermee geeft u op welke itemeigenschappen in het antwoord moeten worden opgenomen als een door komma's gescheiden lijst. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.
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.
PrincipalType

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
SensitivityLabel

Vertegenwoordigt een vertrouwelijkheidslabel dat is toegepast op een item.
ServicePrincipalDetails

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.
ServicePrincipalPrincipal

Vertegenwoordigt een Microsoft Entra service-principal.
ServicePrincipalProfileDetails

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Vertegenwoordigt een service-principalprofiel.
UserDetails

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.
UserPrincipal

Vertegenwoordigt een Microsoft Entra gebruikersprincipaal.

EntireTenantPrincipal

Object

Vertegenwoordigt een tenant-principal

Name Type Description
displayName

string

De weergavenaam van de principal.
id

string (uuid)

De id van de principal.
type string:

EntireTenant

Het type principal. Er kunnen in de loop van de tijd extra principal-typen 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 (uuid)

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.

GroupDetails

Object

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

Name Type Description
groupType

GroupType

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

GroupPrincipal

Object

Vertegenwoordigt een beveiligingsgroep.

Name Type Description
displayName

string

De weergavenaam van de principal.
groupDetails

GroupDetails

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.
id

string (uuid)

De id van de principal.
type string:

Group

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

GroupType

Opsomming

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Waarde Description
Unknown

Het type Principal-groep is onbekend.
SecurityGroup

Principal is een beveiligingsgroep.
DistributionList

Principal is een distributielijst.

Item

Object

Een itemobject.

Name Type Description
defaultIdentity Principal:

De standaardidentiteit van het item.
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.
sensitivityLabel

SensitivityLabel

Het vertrouwelijkheidslabel voor items.
tags

ItemTag[]

Lijst met toegepaste tags.
type

ItemType

Het itemtype.
workspaceId

string (uuid)

De werkruimte-id.

ItemIncludeOption

Opsomming

Hiermee geeft u op welke itemeigenschappen in het antwoord moeten worden opgenomen als een door komma's gescheiden lijst. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

Waarde Description
DefaultIdentity

Bevat de standaardidentiteit

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.
DataAgent

Een DataAgent.
MirroredCatalog

Een mirroredCatalog.

PrincipalType

Opsomming

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

Waarde Description
User

Principal is een Microsoft Entra user principal.
ServicePrincipal

Principal is een Microsoft Entra service-principal.
Group

Principal is een beveiligingsgroep.
ServicePrincipalProfile

Principal is een service-principalprofiel.
EntireTenant

Principal vertegenwoordigt alle tenantgebruikers.

SensitivityLabel

Object

Vertegenwoordigt een vertrouwelijkheidslabel dat is toegepast op een item.

Name Type Description
id

string (uuid)

De vertrouwelijkheidslabel-id.

ServicePrincipalDetails

Object

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

Name Type Description
aadAppId

string (uuid)

De Microsoft Entra AppId van de service-principal.

ServicePrincipalPrincipal

Object

Vertegenwoordigt een Microsoft Entra service-principal.

Name Type Description
displayName

string

De weergavenaam van de principal.
id

string (uuid)

De id van de principal.
servicePrincipalDetails

ServicePrincipalDetails

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.
type string:

ServicePrincipal

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

ServicePrincipalProfileDetails

Object

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

Name Type Description
parentPrincipal Principal:

De bovenliggende principal van het service-principalprofiel.

ServicePrincipalProfilePrincipal

Object

Vertegenwoordigt een service-principalprofiel.

Name Type Description
displayName

string

De weergavenaam van de principal.
id

string (uuid)

De id van de principal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

UserDetails

Object

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

Name Type Description
userPrincipalName

string

De gebruikersprincipe-naam (UPN).

UserPrincipal

Object

Vertegenwoordigt een Microsoft Entra gebruikersprincipaal.

Name Type Description
displayName

string

De weergavenaam van de principal.
id

string (uuid)

De id van de principal.
type string:

User

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
userDetails

UserDetails

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.