Items - Get Upstream Relations (beta)

サービス:: Core

API バージョン:: v1

アイテムのアップストリームリレーションを取得します。

Note

この API はベータリリースの一部であり、評価と開発のみを目的として提供されます。フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。 この API を呼び出すとき、呼び出し元はクエリパラメーター trueの値としてbetaを指定する必要があります。

指定したアイテムの上流にあるすべての項目 (リレーションエッジと参照されるワークスペースを含む) を返します。

Permissions

呼び出し元には、アイテムの 読み取り アクセス許可が必要です。

必要な委任スコープ

Item.Read.All または Item.ReadWrite.All

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

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

アイデンティティ	Support
User	はい
サービスプリンシパルとマネージド ID	はい

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/relations/upstream?beta={beta}

URI パラメーター

名前	/	必須	型	説明
itemId	path	True	string (uuid)	アイテム ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。
beta	query	True	boolean	この API にアクセスするには、この必須パラメーターを `true` に設定する必要があります。これは現在ベータ版です。

応答

名前型説明

200 OK

名前	型	説明
200 OK	RelationsResponse	要求は正常に完了しました。
429 Too Many Requests	ErrorResponse	サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す `Retry-After` ヘッダーを返します。ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラーコード: ItemNotFound - 要求された項目が見つかりませんでした。 InsufficientPrivileges - 呼び出し元には、アイテムにアクセスするための十分なアクセス許可がありません。

RelationsResponse

要求は正常に完了しました。

429 Too Many Requests

ErrorResponse

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

ヘッダー

Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラーコード:

ItemNotFound - 要求された項目が見つかりませんでした。
InsufficientPrivileges - 呼び出し元には、アイテムにアクセスするための十分なアクセス許可がありません。

例

Get upstream relations example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/3546052c-ae64-4526-b1a8-52af7761426f/relations/upstream?beta=True

応答のサンプル

状態コード:: 200

{
  "items": [
    {
      "id": "9b218778-e7a5-4d73-8187-f10824047715",
      "type": "Lakehouse",
      "displayName": "Enterprise Sales Lakehouse",
      "workspaceId": "9a1f7d8b-4f9c-4c1e-b8e7-3d6c2b0a5f41"
    }
  ],
  "relations": [
    {
      "itemId": "3546052c-ae64-4526-b1a8-52af7761426f",
      "dependentOnItemId": "9b218778-e7a5-4d73-8187-f10824047715",
      "relationType": "PushData"
    }
  ],
  "workspaces": [
    {
      "id": "9a1f7d8b-4f9c-4c1e-b8e7-3d6c2b0a5f41",
      "displayName": "Data Engineering Workspace"
    }
  ]
}

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ItemType	アイテムの種類。追加の項目の種類は、時間の経過と同時に追加される場合があります。
RelationsEdge	2 つの項目間のリレーションシップエッジ。
RelationsRelatedItem	指定した項目に関連する項目。これは、リレーション API によって返されるプロパティのみを含む、完全な項目オブジェクトのサブセットです。
RelationsResponse	関連アイテム、リレーションエッジ、および参照されるワークスペースを含む応答。
RelationsWorkspace	リレーションの応答で参照されるワークスペース。
RelationType	2 つの項目間の関係の種類。追加のリレーションシップの種類は、時間の経過と同時に追加される場合があります。

ErrorRelatedResource

Object

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

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable	boolean	true の場合、要求を再試行できます。 `Retry-After`応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message	string	エラーの人間が理解可能な表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

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。
MirroredCatalog	MirroredCatalog。
AppBackend	AppBackend。
OrgApp	組織アプリ。
OrgAppAudience	組織アプリの対象ユーザー。
DataBuildToolJob	DataBuildToolJob。
AzureDatabricksStorage	Azure Databricksの OneLake に基づくストレージ項目。
Plan	プラン。

RelationsEdge

Object

2 つの項目間のリレーションシップエッジ。

名前	型	説明
dependentOnItemId	string (uuid)	ソースアイテムが依存するアイテムの識別子。
itemId	string (uuid)	ソースアイテム識別子。
relationType	RelationType	2 つの項目間の関係の種類。追加のリレーションシップの種類は、時間の経過と同時に追加される場合があります。

RelationsRelatedItem

Object

指定した項目に関連する項目。これは、リレーション API によって返されるプロパティのみを含む、完全な項目オブジェクトのサブセットです。

名前	型	説明
displayName	string	アイテムの表示名。
id	string (uuid)	アイテム ID。
type	ItemType	アイテムの種類。
workspaceId	string (uuid)	アイテムを含むワークスペースの ID。この ID を使用して、 `workspaces` の一覧でワークスペースを検索します。

RelationsResponse

Object

関連アイテム、リレーションエッジ、および参照されるワークスペースを含む応答。

名前	型	説明
items	RelationsRelatedItem[]	関連項目の一覧。
relations	RelationsEdge[]	アイテム間のリレーションシップエッジの一覧。
workspaces	RelationsWorkspace[]	関連アイテムによって参照されるワークスペースの一覧。

RelationsWorkspace

Object

リレーションの応答で参照されるワークスペース。

名前	型	説明
displayName	string	ワークスペースの表示名。
id	string (uuid)	ワークスペース識別子。

RelationType

列挙

2 つの項目間の関係の種類。追加のリレーションシップの種類は、時間の経過と同時に追加される場合があります。

値	説明
CascadeDelete	CascadeDelete リレーションシップは、アイテムが dependentOnItemId の親であることを示し、アイテムを削除すると、依存アイテムも削除されます。
WeakAssociation	WeakAssociation リレーションシップは、dependentOnItemId によって識別される項目にソフト依存関係があることを示します。依存アイテムが削除されると、リレーションシップが削除されます。
Datasource	データソースリレーションシップは、共通データソースによって識別される項目にソフト依存関係があることを示します。依存アイテムが削除されると、リレーションシップが削除されます。
PushData	PushData リレーションシップは、依存アイテムがデータを dependecy 項目 (dependentOnItemId によって識別される項目) に書き込む/プッシュすることを示します。依存アイテムが削除されると、リレーションシップが削除されます。
Orchestration	オーケストレーションリレーションシップは、項目が依存関係項目 (dependentOnItemId によって識別される項目) の管理プロセスまたはオーケストレーションプロセスを実行することを示します。依存アイテムが削除されると、リレーションシップが削除されます。
Shortcut	ショートカットリレーションシップは、項目に、dependentOnItemId によって識別されるアイテムのデータまたはデータ領域へのショートカットまたはリンクがあることを示します。依存アイテムが削除されると、リレーションシップが削除されます。
HiddenInWorkspace	HiddenInWorkspace は、このリレーションシップを所有するアイテムがワークスペースで非表示になることを示します。