Partager via

Items - List Items

Service:
Core
Version d'API:
v1

Retourne une liste d’éléments de l’espace de travail spécifié.
Cette API prend en charge pagination.

Autorisations

L’appelant doit avoir un rôle d’espace de travail de visionneuse .

Étendues déléguées requises

Workspace.Read.All ou Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
principal de service et identités managées Oui

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items
Avec des paramètres facultatifs: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items?type={type}&recursive={recursive}&rootFolderId={rootFolderId}&continuationToken={continuationToken}

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

ID de l’espace de travail.
continuationToken
 query

string

Jeton permettant de récupérer la page suivante des résultats.
recursive
 query

boolean

Répertorie les éléments d’un dossier et de ses dossiers imbriqués, ou simplement un dossier. True : tous les éléments du dossier et ses dossiers imbriqués sont répertoriés, False : seuls les éléments du dossier sont répertoriés. La valeur par défaut est true.
rootFolderId
 query

string (uuid)

Ce paramètre permet aux utilisateurs de filtrer les éléments en fonction d’un dossier racine spécifique. S’il n’est pas fourni, l’espace de travail est utilisé comme dossier racine.
type
 query

string

Type de l’élément.

Réponses

Nom Type Description
200 OK

Items

La demande s’est terminée avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • InvalidItemType - Type d’élément non valide.

  • FolderNotFound - Impossible de trouver le dossier demandé.

Exemples

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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
}

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
Item

Objet d’élément.
Items
ItemTag

Représente une balise appliquée à un élément.
ItemType

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

Item

Objet

Objet d’élément.

Nom Type Description
description

string

Description de l’élément.
displayName

string

Nom complet de l’élément.
folderId

string (uuid)

ID du dossier.
id

string (uuid)

ID d’élément.
tags

ItemTag[]

Liste des balises appliquées.
type

ItemType

Type d’élément.
workspaceId

string (uuid)

ID de l’espace de travail.

Items

Objet
Nom Type Description
continuationToken

string

Jeton du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
continuationUri

string

URI du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
value

Item[]

Liste d’éléments.

ItemTag

Objet

Représente une balise appliquée à un élément.

Nom Type Description
displayName

string

Nom de la balise.
id

string (uuid)

ID de balise.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Dashboard

Tableau de bord PowerBI.
Report

Rapport PowerBI.
SemanticModel

Modèle sémantique PowerBI.
PaginatedReport

Rapport paginé PowerBI.
Datamart

Datamart PowerBI.
Lakehouse

Un lac.
Eventhouse

Un eventhouse.
Environment

Environnement.
KQLDatabase

Base de données KQL.
KQLQueryset

Ensemble de requêtes KQL.
KQLDashboard

Tableau de bord KQL.
DataPipeline

Un pipeline de données.
Notebook

Un bloc-notes.
SparkJobDefinition

Définition d’un travail Spark.
MLExperiment

Une expérience de Machine Learning.
MLModel

Modèle Machine Learning.
Warehouse

Un entrepôt.
Eventstream

Flux d’événements.
SQLEndpoint

Point de terminaison SQL.
MirroredWarehouse

Un entrepôt mis en miroir.
MirroredDatabase

Une base de données mise en miroir.
Reflex

Un réflexe.
GraphQLApi

API pour l’élément GraphQL.
MountedDataFactory

Un MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

Tâche de copie.
VariableLibrary

A VariableLibrary.
Dataflow

Flux de données.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Capture instantanée de l’entrepôt.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Flux de générateur de jumeaux numériques.
MirroredAzureDatabricksCatalog

Catalogue Azure databricks mis en miroir.
Map

Carte.
AnomalyDetector

Détecteur d’anomalies.
UserDataFunction

Fonction de données utilisateur.
GraphModel

A GraphModel.
GraphQuerySet

Ensemble de requêtes Graph.
SnowflakeDatabase

Une base de données Snowflake pour stocker les tables Iceberg créées à partir du compte Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Base de données Cosmos DB.
Ontology

Une ontologie.
EventSchemaSet

An EventSchemaSet.