Item Lifecycle - On Restore Item

Service:: Workload Development

API Version:: v1

Called by Microsoft Fabric for restoring a soft-deleted item.
Upon item restore Fabric performs basic validations and calls this API to notify the workload. The workload is expected to restore the item metadata and re-allocate required resources.

Permissions

Permissions are checked by Microsoft Fabric.

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

URI Parameters

Name	In	Required	Type	Description
itemId	path	True	string (uuid)	The item ID.
itemType	path	True	string	The item type.
workspaceId	path	True	string (uuid)	The workspace ID.

Request Header

Name	Required	Type	Description
ActivityId	True	string (uuid)	A unique ID for correlating the request with your system when a user interacts with your workload.
RequestId	True	string (uuid)	A globally unique ID that helps Fabric correlate your request with our logs. Provide this ID when reporting an issue.
Authorization	True	string	A dual token authorization header that allows the workload to validate the request origin, provide user context, and call other services. This header has the following format: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	The tenant ID of the client making the request.

Request Body

Name	Type	Description
definition	ItemDefinition	Represents the inline definition of an item.

Responses

Name	Type	Description
200 OK		Successfully restored.
Other Status Codes	ErrorResponse	For error conditions the workload should return an appropriate HTTP error status code (4xx, 5xx) with detailed error information in the response body.

Examples

Restore item example

Sample request

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"
      }
    ]
  }
}

Sample response

Status code:: 200

Definitions

Name	Description
ErrorExtendedInformation	The extended error information.
ErrorResponse	The error response.
ErrorSource	The source of the error.
ItemDefinition	Represents the inline definition of an item.
ItemDefinitionPart	Represents a part of an item definition.
NameValuePair	A name-value pair.
OnRestoreItemRequest	Request body for restoring a soft-deleted item in a remote workload.

ErrorExtendedInformation

Object

The extended error information.

Name	Type	Description
additionalParameters	NameValuePair[]	A list of additional parameters specific to the error.
errorCode	string	The error code.
message	string	The error message.
messageParameters	string[]	A list of parameters for formatting a localized message.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	The error code.
isPermanent	boolean	Indicates whether the error is permanent or the operation can be retried.
message	string	The error message.
messageParameters	string[]	A list of parameters for formatting a localized message.
moreDetails	ErrorExtendedInformation[]	A list of additional error details.
source	ErrorSource	The source of the error.

ErrorSource

Enumeration

The source of the error.

Value	Description
System	The error originated from the system.
User	The error originated from user input.
External	The error originated from an external source.

ItemDefinition

Object

Represents the inline definition of an item.

Name	Type	Description
parts	ItemDefinitionPart[]	The definition parts.

ItemDefinitionPart

Object

Represents a part of an item definition.

Name	Type	Description
path	string	The path of the part (e.g., '.platform').
payload	string	The payload (inline Base64 content).
payloadType	string	The payload type (e.g., 'InlineBase64').

NameValuePair

Object

A name-value pair.

Name	Type	Description
name	string	The name.
value	string	The value.

OnRestoreItemRequest

Object

Request body for restoring a soft-deleted item in a remote workload.

Name	Type	Description
definition	ItemDefinition	Represents the inline definition of an item.