次の方法で共有

Items - Update Item

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

指定した項目のプロパティを更新します。
この API は、多数の項目の種類でサポートされており、サポートされている項目の種類とその定義構造に関する情報は、項目管理の概要で確認できます。

権限

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

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

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

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

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

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
itemId
 path True

string

uuid

アイテム ID。
workspaceId
 path True

string

uuid

ワークスペース ID。

要求本文

名前 型 説明
description

string

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

string

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

応答

名前 型 説明
200 OK

Item

要求は正常に完了しました。
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • ItemNotFound - 要求された項目が見つかりませんでした。

  • InvalidRequest - 更新要求が無効です。

例

Update an item example

要求のサンプル

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Item's New name",
  "description": "Item's New description"
}

応答のサンプル

状態コード:
200 
{
  "displayName": "Item's New name",
  "description": "Item's New description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
Item

項目オブジェクト。
ItemType

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

アイテムの更新要求。

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。

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

倉庫。

UpdateItemRequest

Object

アイテムの更新要求。

名前 型 説明
description

string

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

string

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