Items - List Items

服務:: Core

API 版本:: v1

從指定的工作區傳回項目清單。
此 API 支援分頁。

權限

呼叫端必須具有 查看器 工作區角色。

必要的委派範圍

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別。

身份	支援
使用者	是的
服務主體和受控識別	是的

介面

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 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string (uuid)	工作區標識碼。
continuationToken	query		string	用來擷取下一頁結果的令牌。
recursive	query		boolean	列出資料夾中的專案及其巢狀資料夾，或只列出資料夾。 True - 資料夾中的所有專案及其巢狀資料夾都會列出 False - 只會列出資料夾中的專案。預設值為 True。
rootFolderId	query		string (uuid)	此參數可讓用戶根據特定根資料夾篩選專案。如果未提供，則會使用工作區作為根資料夾。
type	query		string	專案的型別。

回應

名稱	類型	Description
200 OK	Items	要求成功完成。
Other Status Codes	ErrorResponse	常見的錯誤碼： InvalidItemType - 無效的項目類型。 FolderNotFound - 找不到要求的資料夾。

名稱

類型

Description

200 OK

Items

要求成功完成。

Other Status Codes

ErrorResponse

常見的錯誤碼：

InvalidItemType - 無效的項目類型。
FolderNotFound - 找不到要求的資料夾。

範例

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

範例要求

HTTP

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

範例回覆

狀態碼:: 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

範例要求

HTTP

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

範例回覆

狀態碼:: 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

範例要求

HTTP

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

範例回覆

狀態碼:: 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

範例要求

HTTP

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

範例回覆

狀態碼:: 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

範例要求

HTTP

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

範例回覆

狀態碼:: 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

範例要求

HTTP

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

範例回覆

狀態碼:: 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"
}

定義

名稱	Description
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
Item	項目物件。
Items
ItemTag	表示在專案上套用的標記。
ItemType	專案的型別。可能會隨著時間新增其他項目類型。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

Item

Object

項目物件。

名稱	類型	Description
description	string	專案描述。
displayName	string	項目顯示名稱。
folderId	string (uuid)	資料夾識別碼。
id	string (uuid)	項目標識碼。
tags	ItemTag[]	已套用標籤的清單。
type	ItemType	項目類型。
workspaceId	string (uuid)	工作區標識碼。

Items

Object

名稱	類型	Description
continuationToken	string	下一個結果集批次的令牌。如果沒有其他記錄，則會從回應中移除。
continuationUri	string	下一個結果集批次的 URI。如果沒有其他記錄，則會從回應中移除。
value	Item[]	項目清單。

ItemTag

Object

表示在專案上套用的標記。

名稱	類型	Description
displayName	string	標籤的名稱。
id	string (uuid)	標記標識碼。

ItemType

列舉型別

專案的型別。可能會隨著時間新增其他項目類型。

值	Description
Dashboard	PowerBI 儀錶板。
Report	PowerBI 報表。
SemanticModel	PowerBI 語意模型。
PaginatedReport	PowerBI 編頁報表。
Datamart	PowerBI datamart。
Lakehouse	湖屋
Eventhouse	事件屋。
Environment	環境。
KQLDatabase	KQL 資料庫。
KQLQueryset	KQL 查詢集。
KQLDashboard	KQL 儀錶板。
DataPipeline	數據管線。
Notebook	筆記本。
SparkJobDefinition	Spark 作業定義。
MLExperiment	機器學習實驗。
MLModel	機器學習模型。
Warehouse	倉儲。
Eventstream	eventstream。
SQLEndpoint	SQL 端點。
MirroredWarehouse	鏡像倉儲。
MirroredDatabase	鏡像資料庫。
Reflex	反射。
GraphQLApi	GraphQL 專案的 API。
MountedDataFactory	MountedDataFactory。
SQLDatabase	SQLDatabase。
CopyJob	複製作業。
VariableLibrary	VariableLibrary。
Dataflow	數據流。
ApacheAirflowJob	ApacheAirflowJob。
WarehouseSnapshot	倉儲快照集。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	數字對應項產生器流程。
MirroredAzureDatabricksCatalog	鏡像的 Azure databricks 目錄。
Map	一張地圖。
AnomalyDetector	異常偵測器。
UserDataFunction	使用者資料函數。
GraphModel	GraphModel 的 GraphModel。
GraphQuerySet	圖形 QuerySet。
SnowflakeDatabase	一個 Snowflake 資料庫，用來儲存由 Snowflake 帳號建立的 Iceberg 表格。
OperationsAgent	一個行動特工。
CosmosDBDatabase	一個 Cosmos 資料庫。
Ontology	一個本體論。
EventSchemaSet	一個事件結構集。

共用方式為

Items - List Items

權限

必要的委派範圍

Microsoft Entra 支援的身分識別

介面

URI 參數

回應

範例

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

範例要求

範例回覆

定義

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Item

Items

ItemTag

ItemType