Items - Get Item Definition

Service:: Core

API バージョン:: v1

指定した項目定義を返します。
この API は、さまざまな項目の種類でサポートされており、サポートされている項目の種類と、その定義構造に関する情報は、項目定義の概要で確認できます。項目の定義を取得する場合、秘密度ラベルは定義の一部ではありません。

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

権限

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

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

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

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

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

制限事項

この API は、呼び出し元が秘密度ラベルを削除する使用権限を持っていない限り、保護された秘密度ラベルを持つ項目に対してブロックされます。

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

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

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

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition

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

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

URI パラメーター

Name	/	必須	型	説明
itemId	path	True	string (uuid)	アイテム ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。
format	query		string	項目定義の形式。

応答

Name	型	説明
200 OK	ItemDefinitionResponse	要求は正常に完了しました。
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 an item definition example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

定義

Name	説明
ErrorParameter	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ItemDefinition	項目定義オブジェクト。
ItemDefinitionPart	項目定義パーツオブジェクト。
ItemDefinitionResponse	項目のパブリック定義の応答。
PayloadType	定義パーツペイロードの型。追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

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	ペイロードの種類。

ItemDefinitionResponse

Object

項目のパブリック定義の応答。

Name	型	説明
definition	ItemDefinition	項目定義オブジェクト。

PayloadType

列挙

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

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