Item Lifecycle - On Delete Item

サービス:: Workload Development

API バージョン:: v1

既存のアイテムを削除するためにMicrosoft Fabricによって呼び出されます。
項目の削除時に、Fabric は基本的な検証を実行し、この API を呼び出してワークロードに通知します。ワークロードは、項目メタデータと空きリソースを削除することが期待されます。

要求には、削除がハードかソフトかを示すdeleteTypeが含まれています。論理的な削除は、後で OnRestoreItem API を使用して項目を復元できるため、ワークロードは復元をサポートするために十分なメタデータとリソースを保持する必要があることを意味します。ハード削除は永続的であり、ワークロードは関連するすべてのデータを完全にクリーンアップする必要があります。

この API は、SubjectAndApp 認証を受け入れる必要があります。ただし、場合によっては、サブジェクトトークンが使用できない場合があります。

アクセス許可

アクセス許可は、Microsoft Fabricによってチェックされます。

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}/OnDeleteItem

URI パラメーター

名前	/	必須	型	説明
itemId	path	True	string (uuid)	アイテム ID。
itemType	path	True	string	アイテムの種類。
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求ヘッダー

名前	必須	型	説明
ActivityId	True	string (uuid)	ユーザーがワークロードと対話するときに、要求をシステムと関連付けするための一意の ID。
RequestId	True	string (uuid)	Fabric が要求をログと関連付けるのに役立つグローバルに一意の ID。問題を報告するときに、この ID を指定します。
Authorization	True	string	ワークロードが要求の配信元を検証し、ユーザーコンテキストを提供し、他のサービスを呼び出すデュアルトークン承認ヘッダー。このヘッダーの形式は次のとおりです: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`。
x-ms-client-tenant-id	True	string (uuid)	要求を行うクライアントのテナント ID。

要求本文

名前	必須	型	説明
deleteType	True	DeleteType	削除操作の種類。

応答

名前	型	説明
200 OK		削除成功。
Other Status Codes	ErrorResponse	エラー状態の場合、ワークロードは、応答本文に詳細なエラー情報を含む適切な HTTP エラー状態コード (4xx、5xx) を返す必要があります。

例

Delete item example

要求のサンプル

HTTP

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111/OnDeleteItem

{
  "deleteType": "Hard"
}

応答のサンプル

状態コード:: 200

定義

名前	説明
DeleteType	削除操作の種類。
ErrorExtendedInformation	拡張エラー情報。
ErrorResponse	エラー応答。
ErrorSource	エラーのソースです。
NameValuePair	名前と値のペア。
OnDeleteItemRequest	アイテムを削除するための要求本文。

DeleteType

列挙

削除操作の種類。

値	説明
Hard	ハード削除操作。
Soft	論理的な削除操作。

ErrorExtendedInformation

Object

拡張エラー情報。

名前	型	説明
additionalParameters	NameValuePair[]	エラーに固有の追加パラメーターの一覧。
errorCode	string	エラーコード。
message	string	エラーメッセージ。
messageParameters	string[]	ローカライズされたメッセージを書式設定するためのパラメーターの一覧。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラーコード。
isPermanent	boolean	エラーが永続的であるか、操作を再試行できるかを示します。
message	string	エラーメッセージ。
messageParameters	string[]	ローカライズされたメッセージを書式設定するためのパラメーターの一覧。
moreDetails	ErrorExtendedInformation[]	その他のエラーの詳細の一覧。
source	ErrorSource	エラーのソースです。

ErrorSource

列挙

エラーのソースです。

値	説明
System	エラーはシステムから発生しました。
User	エラーはユーザー入力から発生しました。
External	エラーは外部ソースから発生しました。

NameValuePair

Object

名前と値のペア。

名前	型	説明
name	string	名前。
value	string	値。

OnDeleteItemRequest

Object

アイテムを削除するための要求本文。

名前	型	説明
deleteType	DeleteType	削除操作の種類。