Items - Get Graph Model Definition

サービス:: GraphModel

API バージョン:: v1

指定した GraphModel パブリック定義を返します。

注

GraphModel 項目は現在プレビュー段階です (詳細については、こちらをご覧ください)。

この API は、実行時間の長い操作 (LRO)をサポートします。

GraphModel のパブリック定義を取得する場合、秘密度ラベルは定義の一部ではありません。

Permissions

呼び出し元には、GraphModel の 読み取りと書き込みの アクセス許可が必要です。

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

Item.ReadWrite.All

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

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

アイデンティティ	Support
ユーザー	イエス
サービスプリンシパルとマネージド ID	いいえ

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphModels/{GraphModelId}/getDefinition

省略可能なパラメーターを含む:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphModels/{GraphModelId}/getDefinition?format={format}

URI パラメーター

名前	/	必須	型	説明
GraphModelId	path	True	string (uuid)	GraphModel ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。
format	query		string	GraphModel パブリック定義の形式。

応答

名前	型	説明
200 OK	GraphModelDefinitionResponse	要求は正常に完了しました。
202 Accepted		要求は受け入れ済み。定義の取得が進行中です。ヘッダー Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す `Retry-After` ヘッダーを返します。ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラーコード: OperationNotSupportedForItem - 要求された項目に対する操作はサポートされていません。

例

Get a GraphModel public definition example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/GraphModels/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

応答のサンプル

状態コード:: 200

{
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "graphType.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "graphDefinition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dataSources.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "stylingConfiguration.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

状態コード:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
GraphModelDefinitionFormat	項目定義の形式。追加の `format` 型は、時間の経過と同時に追加される場合があります。
GraphModelDefinitionResponse	GraphModel パブリック定義応答。
GraphModelPublicDefinition	GraphModel パブリック定義オブジェクト。 GraphModel パブリック定義を作成する方法の詳細については、この記事を参照してください。
GraphModelPublicDefinitionPart	GraphModel 定義パーツオブジェクト。
PayloadType	定義パーツペイロードの型。追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

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	エラー関連のリソースの詳細。

GraphModelDefinitionFormat

列挙

項目定義の形式。追加の format 型は、時間の経過と同時に追加される場合があります。

値	説明
json	GraphModel パブリック定義の JSON 形式。特に Fabric の CI/CD シナリオをサポートするように設計されています。

GraphModelDefinitionResponse

Object

GraphModel パブリック定義応答。

名前	型	説明
definition	GraphModelPublicDefinition	GraphModel パブリック定義オブジェクト。 GraphModel パブリック定義を作成する方法の詳細については、この記事を参照してください。

GraphModelPublicDefinition

Object

GraphModel パブリック定義オブジェクト。 GraphModel パブリック定義を作成する方法の詳細については、この記事を参照してください。

名前	型	説明
format	GraphModelDefinitionFormat	項目定義の形式。追加の `format` 型は、時間の経過と同時に追加される場合があります。
parts	GraphModelPublicDefinitionPart[]	定義パーツの一覧。

GraphModelPublicDefinitionPart

Object

GraphModel 定義パーツオブジェクト。

名前	型	説明
path	string	GraphModel パブリック定義パーツのパス。
payload	string	GraphModel パブリック定義パーツのペイロード。
payloadType	PayloadType	ペイロードの種類。

PayloadType

列挙

定義パーツペイロードの型。追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

値	説明
InlineBase64	インラインベース 64。

次の方法で共有

Items - Get Graph Model Definition

Permissions

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

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

インターフェイス

URI パラメーター

応答

例

Get a GraphModel public definition example

要求のサンプル

応答のサンプル

定義

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModelDefinitionFormat

GraphModelDefinitionResponse

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

PayloadType