Items - Delete Item

Service:
Core
API バージョン:
v1

指定した項目を削除します。
この API は、多数の項目の種類でサポートされており、サポートされている項目の種類とその定義構造に関する情報は、項目管理の概要で確認できます。 既定の動作では、サポートされている項目の種類のアイテムを論理的に削除します。

注

論理的に削除されたアイテムは、各ワークスペースで許可されているアイテムの最大数にカウントされます。

権限

呼び出し元は、論理的な削除のためにアイテムの 書き込み アクセス許可を持っている必要があります。 呼び出し元には、ハード/永続的な削除のためにワークスペース 管理者 ロールが割り当てられている必要があります。

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

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

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

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

スロットルの制限

制限の種類 Value
プラットフォーム API の統合クォータ 500 通話/分
API の制限 200 通話/分

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

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

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

インターフェイス

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

URI パラメーター

Name / 必須 型 説明
itemId
 path True

string (uuid)

アイテム ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。
hardDelete
 query

boolean

ハード削除を実行するかどうかを指定します。 trueに設定すると、アイテムは完全に削除され、回復できません。 falseに設定するか、指定しない場合、アイテムの種類でサポートされている場合、アイテムは論理的に削除されます。

応答

Name 型 説明
200 OK

要求は正常に完了しました。
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

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

  • InsufficientWorkspaceRole - ユーザーに十分なワークスペース ロールがありません。

  • FeatureNotAvailable - これは、論理的な削除機能が使用できないことが原因である可能性があります。

  • UnsupportedItemType - これは、要求された項目の種類でサポートされていない論理的な削除機能が原因である可能性があります。

  • TenantSwitchDisabled - これは、テナント管理者によって論理的な削除機能が無効になっている可能性があります。

  • InvalidTargetItemStateForSoftDeletion - アイテムが論理的な削除に対して無効な状態になっています。

  • InvalidParentItemStateForSoftDeletion - アイテムの親アイテムがアクティブな状態ではありません。

例

Delete an item example
Hard delete an item example

Delete an item example

要求のサンプル

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

応答のサンプル

状態コード:
200

Hard delete an item example

要求のサンプル

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

応答のサンプル

状態コード:
200

定義

Name 説明
ErrorParameter

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

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。

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

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