Item Lifecycle - On Restore Item

サービス:: Workload Development

API バージョン:: v1

論理的に削除されたアイテムを復元するためにMicrosoft Fabricによって呼び出されます。
項目の復元時に、Fabric は基本的な検証を実行し、この API を呼び出してワークロードに通知します。ワークロードでは、項目メタデータを復元し、必要なリソースを再割り当てすることが期待されます。

アクセス許可

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

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

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。

要求本文

名前	型	説明
definition	ItemDefinition	項目のインライン定義を表します。

応答

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

例

Restore 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/OnRestoreItem

{
  "definition": {
    "parts": [
      {
        "path": ".platform",
        "payload": "eyJuYW1lIjogIk15IERhdGEgV2FyZWhvdXNlIn0=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

応答のサンプル

状態コード:: 200

定義

名前	説明
ErrorExtendedInformation	拡張エラー情報。
ErrorResponse	エラー応答。
ErrorSource	エラーのソースです。
ItemDefinition	項目のインライン定義を表します。
ItemDefinitionPart	項目定義の一部を表します。
NameValuePair	名前と値のペア。
OnRestoreItemRequest	リモートワークロードで論理的に削除された項目を復元するための要求本文。

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	エラーは外部ソースから発生しました。

ItemDefinition

Object

項目のインライン定義を表します。

名前	型	説明
parts	ItemDefinitionPart[]	定義パーツ。

ItemDefinitionPart

Object

項目定義の一部を表します。

名前	型	説明
path	string	パーツのパス (例: ".platform")。
payload	string	ペイロード (インラインの Base64 コンテンツ)。
payloadType	string	ペイロードの種類 (例: 'InlineBase64')。

NameValuePair

Object

名前と値のペア。

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

OnRestoreItemRequest

Object

リモートワークロードで論理的に削除された項目を復元するための要求本文。

名前	型	説明
definition	ItemDefinition	項目のインライン定義を表します。