Items - Get Graph Model Definition

服務:

GraphModel

API 版本:

v1

傳回指定的 GraphModel 公用定義。

備註

GraphModel 項目目前處於預覽狀態 （深入瞭解）。

此 API 支援 長時間執行的作業 （LRO）。

當您取得 GraphModel 的公用定義時，敏感度標籤不是定義的一部分。

權限

呼叫端必須具有 GraphModel 的 讀取和寫入 許可權。

必要的委派範圍

Item.ReadWrite.All

Microsoft Entra 支援的身份

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

身份	Support
User	Yes
服務主體 和 受控識別	Yes

介面

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

名稱	位於	必要	類型	Description
graphModelId	path	True	string (uuid)	GraphModel ID。
workspaceId	path	True	string (uuid)	工作區識別碼。
format	query		string	GraphModel 公用定義的格式。

回應

名稱	類型	Description
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

定義

名稱	Description
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
GraphModelDefinitionFormat	項目定義的格式。 可能會隨著時間新增其他 format 類型。
GraphModelDefinitionResponse	GraphModel 公開定義回應。
GraphModelPublicDefinition	GraphModel 公用定義物件。 有關圖模型定義結構的更多細節，請參閱本文。
GraphModelPublicDefinitionPart	GraphModel 定義零件物件。
PayloadType	定義元件承載的類型。 可能會隨著時間新增其他承載類型。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

錯誤回應。

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

ErrorResponseDetails

Object

錯誤回應詳細數據。

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

GraphModelDefinitionFormat

列舉型別

項目定義的格式。 可能會隨著時間新增其他 format 類型。

值	Description
json	GraphModel 公用定義的 JSON 格式，特別設計用於支援 Fabric 中的 CI/CD 案例。

GraphModelDefinitionResponse

Object

GraphModel 公開定義回應。

名稱	類型	Description
definition	GraphModelPublicDefinition	GraphModel 公用定義物件。 有關圖模型定義結構的更多細節，請參閱本文。

GraphModelPublicDefinition

Object

GraphModel 公用定義物件。 有關圖模型定義結構的更多細節，請參閱本文。

名稱	類型	Description
format	GraphModelDefinitionFormat	項目定義的格式。 可能會隨著時間新增其他 format 類型。
parts	GraphModelPublicDefinitionPart[]	定義元件的清單。

GraphModelPublicDefinitionPart

Object

GraphModel 定義零件物件。

名稱	類型	Description
path	string	GraphModel 公用定義零件路徑。
payload	string	GraphModel 公用定義部分承載。
payloadType	PayloadType	承載類型。

PayloadType

列舉型別

定義元件承載的類型。 可能會隨著時間新增其他承載類型。

值	Description
InlineBase64	內嵌基底 64。