Items - Update Item Definition

Service:
Core
API バージョン:
v1

指定した項目の定義をオーバーライドします。
この API は、さまざまな項目の種類でサポートされており、サポートされている項目の種類と、その定義構造に関する情報は 、項目定義の概要で確認できます。 アイテムの定義を更新しても、その秘密度ラベルには影響しません。

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

権限

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

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

項目 API の場合は、次のスコープの種類を使用します。

  • 汎用スコープ: Item.ReadWrite.All
  • 特定のスコープ: itemType。ReadWrite.All (例: Notebook.ReadWrite.All)

スコープの詳細については、スコープに関する記事を参照してください。

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

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

アイデンティティ 支援
ユーザー イエス
サービス プリンシパルとマネージド ID 呼び出しの項目の種類がサポートされている場合。 呼び出しがサポートされているかどうかを確認するには、呼び出す項目の種類に対応する API を確認します。 たとえば、セマンティック モデルがサポートされています。

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition
省略可能なパラメーターを含む: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition?updateMetadata={updateMetadata}

URI パラメーター

Name / 必須 型 説明
itemId
 path True

string (uuid)

アイテム ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。
updateMetadata
 query

boolean

true に設定され、.platform ファイルが定義の一部として提供されると、.platform ファイル内のメタデータを使用して項目のメタデータが更新されます。

要求本文

Name 必須 型 説明
definition True

ItemDefinition

項目定義オブジェクト。
options

object

定義が更新されるアイテムのオプション。 プロパティ名は、項目の種類に対して有効なオプション名です。値はオプション値です。 特定の項目の種類でサポートされるオプションについては、その項目の種類の Update-Definition API のドキュメントを参照してください。

応答

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 an item definition example

要求のサンプル

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

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "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

エラー応答の詳細。
ItemDefinition

項目定義オブジェクト。
ItemDefinitionPart

項目定義パーツ オブジェクト。
PayloadType

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

アイテム定義要求ペイロードを更新します。

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

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

ItemDefinition

Object

項目定義オブジェクト。

Name 型 説明
format

string

項目定義の形式。
parts

ItemDefinitionPart[]

定義パーツの一覧。

ItemDefinitionPart

Object

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

Name 型 説明
path

string

アイテム パーツのパス。
payload

string

項目パーツのペイロード。
payloadType

PayloadType

ペイロードの種類。

PayloadType

列挙

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

値 説明
InlineBase64

インライン ベース 64。

UpdateItemDefinitionRequest

Object

アイテム定義要求ペイロードを更新します。

Name 型 説明
definition

ItemDefinition

項目定義オブジェクト。
options

object

定義が更新されるアイテムのオプション。 プロパティ名は、項目の種類に対して有効なオプション名です。値はオプション値です。 特定の項目の種類でサポートされるオプションについては、その項目の種類の Update-Definition API のドキュメントを参照してください。