Dela via


Items - List Items

Returnerar en lista med objekt från den angivna arbetsytan.
Det här API:et stöder sidnumrering.

Behörigheter

Anroparen måste ha en arbetsyteroll för visningsprogrammet .

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet Stöd
Användare Ja
Tjänstens huvudnamn och hanterade identiteter Ja

Gränssnitt

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-parametrar

Namn I Krävs Typ Beskrivning
workspaceId
path True

string (uuid)

Arbetsytans ID.

continuationToken
query

string

En token för att hämta nästa sida med resultat.

recursive
query

boolean

Listar objekt i en mapp och dess kapslade mappar, eller bara en mapp. Sant – Alla objekt i mappen och dess kapslade mappar visas, False – Endast objekt i mappen visas. Standardvärdet är sant.

rootFolderId
query

string (uuid)

Med den här parametern kan användare filtrera objekt baserat på en specifik rotmapp. Om det inte anges används arbetsytan som rotmapp.

type
query

string

Objektets typ.

Svaren

Namn Typ Beskrivning
200 OK

Items

Begäran har slutförts.

Other Status Codes

ErrorResponse

Vanliga felkoder:

  • InvalidItemType – Ogiltig objekttyp.

  • FolderNotFound – Det gick inte att hitta den begärda mappen.

Exempel

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

Exempelförfrågan

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

Exempelsvar

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

Exempelförfrågan

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

Exempelsvar

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

Exempelförfrågan

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

Exempelsvar

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

Exempelförfrågan

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

Exempelsvar

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

Exempelförfrågan

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

Exempelsvar

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

Exempelförfrågan

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

Exempelsvar

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

Definitioner

Namn Beskrivning
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.

ErrorResponse

Felsvaret.

ErrorResponseDetails

Information om felsvar.

Item

Ett objektobjekt.

Items
ItemTag

Representerar en tagg som tillämpas på ett objekt.

ItemType

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.

Namn Typ Beskrivning
resourceId

string

Det resurs-ID som ingår i felet.

resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Felsvaret.

Namn Typ Beskrivning
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.

message

string

En mänsklig läsbar representation av felet.

moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.

relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

requestId

string

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Information om felsvar.

Namn Typ Beskrivning
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.

message

string

En mänsklig läsbar representation av felet.

relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

Item

Ett objektobjekt.

Namn Typ Beskrivning
description

string

Objektbeskrivningen.

displayName

string

Objektets visningsnamn.

folderId

string (uuid)

Mapp-ID:t.

id

string (uuid)

Objekt-ID:t.

tags

ItemTag[]

Lista över tillämpade taggar.

type

ItemType

Objekttypen.

workspaceId

string (uuid)

Arbetsytans ID.

Items

Namn Typ Beskrivning
continuationToken

string

Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.

continuationUri

string

URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.

value

Item[]

En lista över objekt.

ItemTag

Representerar en tagg som tillämpas på ett objekt.

Namn Typ Beskrivning
displayName

string

Namnet på taggen.

id

string (uuid)

Tagg-ID:t.

ItemType

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde Beskrivning
Dashboard

PowerBI-instrumentpanel.

Report

PowerBI-rapport.

SemanticModel

PowerBI-semantisk modell.

PaginatedReport

Sidnumrerad PowerBI-rapport.

Datamart

PowerBI-datamart.

Lakehouse

Ett sjöhus.

Eventhouse

Ett eventhouse.

Environment

En miljö.

KQLDatabase

En KQL-databas.

KQLQueryset

En KQL-frågeuppsättning.

KQLDashboard

En KQL-instrumentpanel.

DataPipeline

En datapipeline.

Notebook

En notebook-fil.

SparkJobDefinition

En definition för Spark-jobb.

MLExperiment

Ett maskininlärningsexperiment.

MLModel

En maskininlärningsmodell.

Warehouse

Ett lager.

Eventstream

En händelseström.

SQLEndpoint

En SQL-slutpunkt.

MirroredWarehouse

Ett speglat lager.

MirroredDatabase

En speglad databas.

Reflex

En reflex.

GraphQLApi

Ett API för GraphQL-objekt.

MountedDataFactory

En MountedDataFactory.

SQLDatabase

En SQLDatabase.

CopyJob

Ett kopieringsjobb.

VariableLibrary

En VariableLibrary.

Dataflow

Ett dataflöde.

ApacheAirflowJob

Ett ApacheAirflowJob.

WarehouseSnapshot

En ögonblicksbild av lagret.

DigitalTwinBuilder

En DigitalTwinBuilder.

DigitalTwinBuilderFlow

Ett Digital Twin Builder Flow.

MirroredAzureDatabricksCatalog

En speglad azure databricks-katalog.

Map

En karta.

AnomalyDetector

En avvikelseidentifiering.

UserDataFunction

En användardatafunktion.

GraphModel

En GraphModel.

GraphQuerySet

En Graph QuerySet.

SnowflakeDatabase

En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.

OperationsAgent

En OperationsAgent.

CosmosDBDatabase

En Cosmos DB-databas.

Ontology

En ontologi.

EventSchemaSet

En EventSchemaSet.