Items - Update Semantic Model Definition

Service:: SemanticModel

API バージョン:: v1

指定したセマンティックモデルの定義をオーバーライドします。
この API は、実行時間の長い操作 (LRO)をサポートします。

セマンティックモデルの定義を更新しても、その秘密度ラベルには影響しません。

権限

呼び出し元には、セマンティックモデルの 読み取りと書き込みの アクセス許可が必要です。

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

SemanticModel.ReadWrite.All または Item.ReadWrite.All

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

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

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

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/updateDefinition

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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/updateDefinition?updateMetadata={updateMetadata}

URI パラメーター

Name	/	必須	型	説明
semanticModelId	path	True	string (uuid)	セマンティックモデル ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。
updateMetadata	query		boolean	true に設定され、.platform ファイルが定義の一部として提供されると、.platform ファイル内のメタデータを使用して項目のメタデータが更新されます。

要求本文

Name	必須	型	説明
definition	True	SemanticModelDefinition	セマンティックモデルのパブリック定義オブジェクトをします。セマンティックモデル定義の構造の詳細については、この記事を参照してください。
options		SemanticModelDefinitionOptions	定義が更新されるセマンティックモデルのオプション。

応答

Name	型	説明
200 OK		要求は正常に完了しました。
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 - 要求された項目に対する操作はサポートされていません。 CorruptedPayload - 指定されたペイロードが破損しています。

例

Update a semantic model definition example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "model.bim",
        "payload": "ewogICJjb21wYXRpYmlsaXR5TGV2ZW..GVzIjogWyBdDQogIH0NCn0",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbism",
        "payload": "ewogICJ2ZXJzaW9uIjogIjQuMC..HRpbmdzIjoge30KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

応答のサンプル

状態コード:: 200

状態コード:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

定義

Name	説明
ErrorParameter	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
PayloadType	定義パーツペイロードの型。追加のペイロードの種類は、時間の経過と同時に追加される場合があります。
SemanticModelDefinition	セマンティックモデルのパブリック定義オブジェクトをします。セマンティックモデル定義の構造の詳細については、この記事を参照してください。
SemanticModelDefinitionOptions	定義を使用してセマンティックモデルを作成するとき、またはセマンティックモデルの定義を更新するときに適用されるオプション。
SemanticModelDefinitionPart	セマンティックモデル定義パーツオブジェクト。
UpdateSemanticModelDefinitionRequest	セマンティックモデルのパブリック定義要求ペイロードを更新します。

ErrorParameter

Object

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

Name	型	説明
message	string	パラメーターの意味を人間が判読できる説明。
name	string	パラメータ識別子です。
value	string	パラメーターの値を指定します。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

エラー応答。

Name	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable	boolean	true の場合、要求を再試行できます。 `Retry-After`応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
parameters	ErrorParameter[]	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

Name	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
parameters	ErrorParameter[]	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

PayloadType

列挙

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

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

SemanticModelDefinition

Object

セマンティックモデルのパブリック定義オブジェクトをします。セマンティックモデル定義の構造の詳細については、この記事を参照してください。

Name	型	説明
format	string	セマンティックモデル定義の形式。
parts	SemanticModelDefinitionPart[]	定義パーツの一覧。

SemanticModelDefinitionOptions

Object

定義を使用してセマンティックモデルを作成するとき、またはセマンティックモデルの定義を更新するときに適用されるオプション。

Name	型	説明
allowPurgeData	boolean	更新された定義を適用するときにセマンティックモデルの既存のデータの削除を許可するかどうか。定義の変更によっては、既存のデータをクリアする必要があります。これらの変更を続行できるようにするには、これを true に設定します。この場合、新しい定義の下に保持できないデータは消去されます。操作が完了したら、セマンティックモデルを更新してデータを再読み込みします。既定値は false です。

SemanticModelDefinitionPart

Object

セマンティックモデル定義パーツオブジェクト。

Name	型	説明
path	string	セマンティックモデルパーツのパス。
payload	string	セマンティックモデルパーツのペイロード。
payloadType	PayloadType	ペイロードの種類。

UpdateSemanticModelDefinitionRequest

Object

セマンティックモデルのパブリック定義要求ペイロードを更新します。

Name	型	説明
definition	SemanticModelDefinition	セマンティックモデルのパブリック定義オブジェクトをします。セマンティックモデル定義の構造の詳細については、この記事を参照してください。
options	SemanticModelDefinitionOptions	定義が更新されるセマンティックモデルのオプション。