次の方法で共有

Items - List Items

サービス:
Core
API バージョン:
v1

指定したワークスペースの項目の一覧を返します。
この API では 、改ページ位置の修正がサポートされています。

権限

呼び出し元には ビューアー ワークスペース ロールが必要です。

必要な委任されたスコープ

Workspace.Read.All または Workspace.ReadWrite.All

サポートされている ID をMicrosoft Entraする

この API では、このセクションに記載されている Microsoft identities がサポートされています。

同一性 支える
利用者 はい
サービス プリンシパルとマネージド ID はい

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。
continuationToken
 query

string

結果の次のページを取得するためのトークン。
include
 query

ItemIncludeOption[]

応答に含める項目プロパティをコンマ区切りリストとして指定します。 時間の経過と同時に追加の値が追加される場合があります。
recursive
 query

boolean

フォルダー内のアイテムとその入れ子になったフォルダー、または単なるフォルダーのみを一覧表示します。 True - フォルダーとその入れ子になったフォルダー内のすべてのアイテムが一覧表示され、False - フォルダー内の項目のみが一覧表示されます。 これは既定値は true です。
rootFolderId
 query

string (uuid)

このパラメーターを使用すると、ユーザーは特定のルート フォルダーに基づいてアイテムをフィルター処理できます。 指定しない場合、ワークスペースはルート フォルダーとして使用されます。
type
 query

string

アイテムの種類。

応答

名前 型 説明
200 OK

Items

要求は正常に完了しました。
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

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

List all items in a specific folder example

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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"
        }
      }
    }
  ]
}

定義

名前 説明
EntireTenantPrincipal

テナント プリンシパルを表します
ErrorRelatedResource

エラー関連のリソース詳細オブジェクト。
ErrorResponse

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
GroupDetails

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。
GroupPrincipal

セキュリティ グループを表します。
GroupType

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。
Item

項目オブジェクト。
ItemIncludeOption

応答に含める項目プロパティをコンマ区切りリストとして指定します。 時間の経過と同時に追加の値が追加される場合があります。
Items
ItemTag

アイテムに適用されるタグを表します。
ItemType

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。
PrincipalType

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
SensitivityLabel

アイテムに適用される秘密度ラベルを表します。
ServicePrincipalDetails

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。
ServicePrincipalPrincipal

Microsoft Entra サービス プリンシパルを表します。
ServicePrincipalProfileDetails

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。
ServicePrincipalProfilePrincipal

サービス プリンシパル プロファイルを表します。
UserDetails

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。
UserPrincipal

Microsoft Entra ユーザー プリンシパルを表します。

EntireTenantPrincipal

Object

テナント プリンシパルを表します

名前 型 説明
displayName

string

プリンシパルの表示名。
id

string (uuid)

プリンシパルの ID。
type string:

EntireTenant

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string (uuid)

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

GroupDetails

Object

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。

名前 型 説明
groupType

GroupType

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。

GroupPrincipal

Object

セキュリティ グループを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
groupDetails

GroupDetails

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。
id

string (uuid)

プリンシパルの ID。
type string:

Group

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

GroupType

列挙

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。

値 説明
Unknown

プリンシパル グループの種類が不明です。
SecurityGroup

プリンシパルはセキュリティ グループです。
DistributionList

プリンシパルは配布リストです。

Item

Object

項目オブジェクト。

名前 型 説明
defaultIdentity Principal:

アイテムの既定の ID。
description

string

アイテムの説明。
displayName

string

アイテムの表示名。
folderId

string (uuid)

フォルダー ID。
id

string (uuid)

アイテム ID。
sensitivityLabel

SensitivityLabel

項目の秘密度ラベル。
tags

ItemTag[]

適用されたタグの一覧。
type

ItemType

アイテムの種類。
workspaceId

string (uuid)

ワークスペース ID。

ItemIncludeOption

列挙

応答に含める項目プロパティをコンマ区切りリストとして指定します。 時間の経過と同時に追加の値が追加される場合があります。

値 説明
DefaultIdentity

既定の ID を含む

Items

Object
名前 型 説明
continuationToken

string

次の結果セット バッチのトークン。 これ以上レコードがない場合は、応答から削除されます。
continuationUri

string

次の結果セット バッチの URI。 これ以上レコードがない場合は、応答から削除されます。
value

Item[]

項目の一覧。

ItemTag

Object

アイテムに適用されるタグを表します。

名前 型 説明
displayName

string

タグの名前。
id

string (uuid)

タグ ID。

ItemType

列挙

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。

値 説明
Dashboard

PowerBI ダッシュボード。
Report

PowerBI レポート。
SemanticModel

PowerBI セマンティック モデル。
PaginatedReport

PowerBI のページ分割されたレポート。
Datamart

PowerBI データマート。
Lakehouse

レイクハウス。
Eventhouse

イベントハウス。
Environment

環境。
KQLDatabase

KQL データベース。
KQLQueryset

KQL クエリセット。
KQLDashboard

KQL ダッシュボード。
DataPipeline

データ パイプライン。
Notebook

ノートブック。
SparkJobDefinition

Spark ジョブ定義。
MLExperiment

機械学習の実験。
MLModel

機械学習モデル。
Warehouse

倉庫。
Eventstream

イベントストリーム。
SQLEndpoint

SQL エンドポイント。
MirroredWarehouse

ミラー化された倉庫。
MirroredDatabase

ミラー化されたデータベース。
Reflex

反射。
GraphQLApi

GraphQL 項目の API。
MountedDataFactory

MountedDataFactory。
SQLDatabase

SQLDatabase。
CopyJob

コピー ジョブ。
VariableLibrary

VariableLibrary。
Dataflow

データフロー。
ApacheAirflowJob

ApacheAirflowJob。
WarehouseSnapshot

Warehouse スナップショット。
DigitalTwinBuilder

DigitalTwinBuilder。
DigitalTwinBuilderFlow

デジタル ツイン ビルダー フロー。
MirroredAzureDatabricksCatalog

ミラー化された Azure databricks カタログ。
Map

マップ。
AnomalyDetector

Anomaly Detector。
UserDataFunction

ユーザー データ関数。
GraphModel

GraphModel。
GraphQuerySet

Graph QuerySet。
SnowflakeDatabase

Snowflake アカウントから作成された Iceberg テーブルを格納する Snowflake データベース。
OperationsAgent

OperationsAgent。
CosmosDBDatabase

Cosmos DB データベース。
Ontology

オントロジ。
EventSchemaSet

EventSchemaSet。
DataAgent

DataAgent。

PrincipalType

列挙

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

値 説明
User

プリンシパルは、Microsoft Entraユーザー プリンシパルです。
ServicePrincipal

プリンシパルは、Microsoft Entraサービス プリンシパルです。
Group

プリンシパルはセキュリティ グループです。
ServicePrincipalProfile

プリンシパルはサービス プリンシパル プロファイルです。
EntireTenant

プリンシパルは、すべてのテナント ユーザーを表します。

SensitivityLabel

Object

アイテムに適用される秘密度ラベルを表します。

名前 型 説明
id

string (uuid)

秘密度ラベル ID。

ServicePrincipalDetails

Object

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。

名前 型 説明
aadAppId

string (uuid)

サービス プリンシパルの Microsoft Entra AppId。

ServicePrincipalPrincipal

Object

Microsoft Entra サービス プリンシパルを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
id

string (uuid)

プリンシパルの ID。
servicePrincipalDetails

ServicePrincipalDetails

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。
type string:

ServicePrincipal

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

ServicePrincipalProfileDetails

Object

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。

名前 型 説明
parentPrincipal Principal:

サービス プリンシパル プロファイルの親プリンシパル。

ServicePrincipalProfilePrincipal

Object

サービス プリンシパル プロファイルを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
id

string (uuid)

プリンシパルの ID。
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。
type string:

ServicePrincipalProfile

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

UserDetails

Object

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。

名前 型 説明
userPrincipalName

string

ユーザー プリンシパル名。

UserPrincipal

Object

Microsoft Entra ユーザー プリンシパルを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
id

string (uuid)

プリンシパルの ID。
type string:

User

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
userDetails

UserDetails

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。