次の方法で共有

Items - Create Item

  • リファレンス
サービス:
Core
API バージョン:
v1

指定したワークスペースに項目を作成します。
この API は、さまざまな項目の種類でサポートされており、項目管理の概要 でサポートされている項目の種類見つけます。 項目定義の取得 API を使用して、項目定義を取得できます。

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

権限

呼び出し元には、共同作成者 以上のワークスペース ロールが必要です。

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

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

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

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

制限

  • PowerBI Fabric 以外の項目を作成するには、ワークスペースがサポートされている Fabric 容量上にある必要があります。 詳細については、Microsoft Fabric ライセンスの種類を参照してください。
  • PowerBI 項目を作成するには、ユーザーが適切なライセンスを持っている必要があります。 詳細については、Microsoft Fabric ライセンスの種類を参照してください。
  • アイテムを作成するときは、creationPayload または definitionを使用しますが、両方を同時に使用しないでください。

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string

uuid

ワークスペース ID。

要求本文

名前 必須 型 説明
displayName True

string

アイテムの表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。
type True

ItemType

アイテムの種類。
creationPayload

object

アイテムの作成に使用される一連のプロパティ。 関連する種類の 項目の作成 ページは、creationPayload がサポートされているかどうかを示し、項目のプロパティを一覧表示します。 creationPayload または definitionを使用します。 両方を同時に使用することはできません。
definition

ItemDefinition

項目定義。 関連する種類の 項目の作成 ページは、定義がサポートされているかどうかを示し、その構造を詳しく説明します。 definition または creationPayloadを使用します。 両方を同時に使用することはできません。
description

string

アイテムの説明。 最大長は 256 文字です。

応答

名前 型 説明
201 Created

Item

正常に作成されました
202 Accepted

承認された要求、アイテムのプロビジョニングが進行中

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • InvalidItemType - 項目の種類が無効です。

  • ItemDisplayNameAlreadyInUse - 項目の表示名は既に使用されています。

  • CorruptedPayload - 指定されたペイロードが破損しています

例

Create an item example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

応答のサンプル

状態コード:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
状態コード:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

定義

名前 説明
CreateItemRequest

アイテム要求ペイロードを作成します。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
Item

項目オブジェクト。
ItemDefinition

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

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

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。
PayloadType

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

CreateItemRequest

Object

アイテム要求ペイロードを作成します。

名前 型 説明
creationPayload

object

アイテムの作成に使用される一連のプロパティ。 関連する種類の 項目の作成 ページは、creationPayload がサポートされているかどうかを示し、項目のプロパティを一覧表示します。 creationPayload または definitionを使用します。 両方を同時に使用することはできません。
definition

ItemDefinition

項目定義。 関連する種類の 項目の作成 ページは、定義がサポートされているかどうかを示し、その構造を詳しく説明します。 definition または creationPayloadを使用します。 両方を同時に使用することはできません。
description

string

アイテムの説明。 最大長は 256 文字です。
displayName

string

アイテムの表示名。 表示名は、項目の種類に応じて名前付け規則に従う必要があります。
type

ItemType

アイテムの種類。

ErrorRelatedResource

Object

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

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

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

string

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

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

Item

Object

項目オブジェクト。

名前 型 説明
description

string

アイテムの説明。
displayName

string

アイテムの表示名。
id

string

uuid

アイテム ID。
type

ItemType

アイテムの種類。
workspaceId

string

uuid

ワークスペース ID。

ItemDefinition

Object

項目定義オブジェクト。

名前 型 説明
format

string

項目定義の形式。
parts

ItemDefinitionPart[]

定義パーツの一覧。

ItemDefinitionPart

Object

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

名前 型 説明
path

string

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

string

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

PayloadType

ペイロードの種類。

ItemType

列挙

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。

値 説明
Dashboard

PowerBI ダッシュボード。
DataPipeline

データ パイプライン。
Datamart

PowerBI データマート。
Environment

環境。
Eventhouse

イベントハウス。
Eventstream

イベントストリーム。
GraphQLApi

GraphQL 項目の API。
KQLDashboard

KQL ダッシュボード。
KQLDatabase

KQL データベース。
KQLQueryset

KQL クエリセット。
Lakehouse

レイクハウス。
MLExperiment

機械学習の実験。
MLModel

機械学習モデル。
MirroredDatabase

ミラー化されたデータベース。
MirroredWarehouse

ミラー化された倉庫。
MountedDataFactory

MountedDataFactory。
Notebook

ノートブック。
PaginatedReport

PowerBI のページ分割されたレポート。
Reflex

反射。
Report

PowerBI レポート。
SQLDatabase

SQLDatabase。
SQLEndpoint

SQL エンドポイント。
SemanticModel

PowerBI セマンティック モデル。
SparkJobDefinition

Spark ジョブ定義。
Warehouse

倉庫。

PayloadType

列挙

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

値 説明
InlineBase64

インライン ベース 64。