Items - List Items

Služba:
Core
Verze rozhraní API:
v1

Vrátí seznam položek ze zadaného pracovního prostoru.
Toto rozhraní API podporuje stránkování.

Dovolení

Volající musí mít roli pracovního prostoru prohlížeče .

Požadované delegovaná rozsahy

Workspace.Read.All nebo Workspace.ReadWrite.All

Microsoft Entra podporované identity

Toto rozhraní API podporuje Microsoft identity uvedené v této části.

Identita Podpora
Uživatel Ano
Hlavní služba a Spravované identity Ano

Rozhraní

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items
S volitelnými parametry: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items?type={type}&recursive={recursive}&rootFolderId={rootFolderId}&continuationToken={continuationToken}&include=DefaultIdentity

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
workspaceId
 path True

string (uuid)

ID pracovního prostoru.
continuationToken
 query

string

Token pro načtení další stránky výsledků.
include
 query

ItemIncludeOption[]

Určuje, které vlastnosti položky se mají zahrnout do odpovědi jako seznam oddělený čárkami. Další hodnoty mohou být přidány v průběhu času.
recursive
 query

boolean

Vypíše položky ve složce a jejích vnořených složek nebo jenom složku. True – Jsou uvedené všechny položky ve složce a její vnořené složky, Nepravda – Jsou uvedené jenom položky ve složce. Výchozí hodnota je true.
rootFolderId
 query

string (uuid)

Tento parametr umožňuje uživatelům filtrovat položky na základě konkrétní kořenové složky. Pokud není zadaný, pracovní prostor se použije jako kořenová složka.
type
 query

string

Typ položky.

Odpovědi

Name Typ Description
200 OK

Items

Žádost byla úspěšně dokončena.
429 Too Many Requests

ErrorResponse

Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků.

Hlavičky

Retry-After: integer
Other Status Codes

ErrorResponse

Běžné kódy chyb:

  • InvalidItemType – neplatný typ položky.

  • FolderNotFound – Požadovanou složku se nepodařilo najít.

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
        }
      }
    }
  ]
}

Definice

Name Description
EntireTenantPrincipal

Představuje objekt zabezpečení tenanta.
ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.
ErrorResponse

Odpověď na chybu.
ErrorResponseDetails

Podrobnosti o odpovědi na chybu.
GroupDetails

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.
GroupPrincipal

Představuje skupinu zabezpečení.
GroupType

Typ skupiny. V průběhu času je možné přidat další typy skupin.
Item

Objekt položky.
ItemIncludeOption

Určuje, které vlastnosti položky se mají zahrnout do odpovědi jako seznam oddělený čárkami. Další hodnoty mohou být přidány v průběhu času.
Items
ItemTag

Představuje značku použitou u položky.
ItemType

Typ položky. V průběhu času je možné přidat další typy položek.
PrincipalType

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
SensitivityLabel

Představuje popisek citlivosti použitý u položky.
ServicePrincipalDetails

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.
ServicePrincipalPrincipal

Představuje Microsoft Entra instanční objekt.
ServicePrincipalProfileDetails

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Představuje profil instančního objektu.
UserDetails

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.
UserPrincipal

Představuje Microsoft Entra objekt zabezpečení uživatele.

EntireTenantPrincipal

Objekt

Představuje objekt zabezpečení tenanta.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
id

string (uuid)

ID objektu zabezpečení.
type string:

EntireTenant

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name Typ Description
resourceId

string

ID prostředku, které je součástí chyby.
resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable

boolean

Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky Retry-After odpovědi určete zpoždění, pokud je k dispozici.
message

string

Lidské čitelné vyjádření chyby.
moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou
requestId

string (uuid)

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

GroupDetails

Objekt

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.

Name Typ Description
groupType

GroupType

Typ skupiny. V průběhu času je možné přidat další typy skupin.

GroupPrincipal

Objekt

Představuje skupinu zabezpečení.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
groupDetails

GroupDetails

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.
id

string (uuid)

ID objektu zabezpečení.
type string:

Group

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

GroupType

Výčet

Typ skupiny. V průběhu času je možné přidat další typy skupin.

Hodnota Description
Unknown

Typ hlavní skupiny je neznámý.
SecurityGroup

Objekt zabezpečení je skupina zabezpečení.
DistributionList

Objekt zabezpečení je distribuční seznam.

Item

Objekt

Objekt položky.

Name Typ Description
defaultIdentity Principal:

Výchozí identita položky
description

string

Popis položky.
displayName

string

Zobrazovaný název položky.
folderId

string (uuid)

ID složky.
id

string (uuid)

ID položky.
sensitivityLabel

SensitivityLabel

Popisek citlivosti položky.
tags

ItemTag[]

Seznam použitých značek
type

ItemType

Typ položky.
workspaceId

string (uuid)

ID pracovního prostoru.

ItemIncludeOption

Výčet

Určuje, které vlastnosti položky se mají zahrnout do odpovědi jako seznam oddělený čárkami. Další hodnoty mohou být přidány v průběhu času.

Hodnota Description
DefaultIdentity

Zahrnuje výchozí identitu.

Items

Objekt
Name Typ Description
continuationToken

string

Token pro další dávku sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
continuationUri

string

Identifikátor URI další dávky sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
value

Item[]

Seznam položek

ItemTag

Objekt

Představuje značku použitou u položky.

Name Typ Description
displayName

string

Název značky.
id

string (uuid)

ID značky.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota Description
Dashboard

Řídicí panel PowerBI
Report

Sestava PowerBI
SemanticModel

Sémantický model PowerBI
PaginatedReport

Stránkovaná sestava PowerBI
Datamart

Datový diagram PowerBI
Lakehouse

Jezero.
Eventhouse

Eventhouse.
Environment

Prostředí.
KQLDatabase

Databáze KQL.
KQLQueryset

Sada dotazů KQL.
KQLDashboard

Řídicí panel KQL.
DataPipeline

Datový kanál.
Notebook

Poznámkový blok.
SparkJobDefinition

Definice úlohy Sparku.
MLExperiment

Experiment strojového učení.
MLModel

Model strojového učení.
Warehouse

Sklad.
Eventstream

Eventstream.
SQLEndpoint

Koncový bod SQL.
MirroredWarehouse

Zrcadlený sklad.
MirroredDatabase

Zrcadlené databáze.
Reflex

A Reflex.
GraphQLApi

Rozhraní API pro položku GraphQL
MountedDataFactory

A MountedDataFactory.
SQLDatabase

Databáze SQLDatabase.
CopyJob

Úloha kopírování.
VariableLibrary

ProměnnáLibrary.
Dataflow

Tok dat.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Snímek skladu.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Tok digitálního dvojčete.
MirroredAzureDatabricksCatalog

Zrcadlený katalog Azure Databricks.
Map

Mapa.
AnomalyDetector

Detektor anomálií.
UserDataFunction

Funkce uživatelských dat.
GraphModel

A GraphModel.
GraphQuerySet

Sada dotazů grafu.
SnowflakeDatabase

Snowflake Database pro ukládání tabulek Iceberg vytvořených z účtu Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Databáze Cosmos DB.
Ontology

Ontologie.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

ZrcadlenýCatalog.
AppBackend

An AppBackend.
OrgApp

Aplikace organizace.
OrgAppAudience

Cílová skupina aplikace organizace.
DataBuildToolJob

A DataBuildToolJob.
AzureDatabricksStorage

Položka úložiště založené na OneLake pro Azure Databricks.
Plan

Plán.

PrincipalType

Výčet

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

Hodnota Description
User

Objekt zabezpečení je Microsoft Entra objekt zabezpečení uživatele.
ServicePrincipal

Instanční objekt je Microsoft Entra instanční objekt.
Group

Objekt zabezpečení je skupina zabezpečení.
ServicePrincipalProfile

Instanční objekt je profil instančního objektu.
EntireTenant

Objekt zabezpečení představuje všechny uživatele tenanta.

SensitivityLabel

Objekt

Představuje popisek citlivosti použitý u položky.

Name Typ Description
id

string (uuid)

ID popisku citlivosti.

ServicePrincipalDetails

Objekt

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.

Name Typ Description
aadAppId

string (uuid)

Instanční objekt Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Představuje Microsoft Entra instanční objekt.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
id

string (uuid)

ID objektu zabezpečení.
servicePrincipalDetails

ServicePrincipalDetails

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.
type string:

ServicePrincipal

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

ServicePrincipalProfileDetails

Objekt

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.

Name Typ Description
parentPrincipal Principal:

Nadřazený objekt profilu instančního objektu.

ServicePrincipalProfilePrincipal

Objekt

Představuje profil instančního objektu.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
id

string (uuid)

ID objektu zabezpečení.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

UserDetails

Objekt

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.

Name Typ Description
userPrincipalName

string

Jméno hlavního uživatele.

UserPrincipal

Objekt

Představuje Microsoft Entra objekt zabezpečení uživatele.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
id

string (uuid)

ID objektu zabezpečení.
type string:

User

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
userDetails

UserDetails

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.