Edit

Items - Update Mirrored Catalog Definition

Service:
MirroredCatalog
API Version:
v1

Overrides the definition for the specified MirroredCatalog.
This API supports long running operations (LRO).

Overrides the public definition of the specified MirroredCatalog. Updating the MirroredCatalog's definition does not affect its sensitivity label.

Permissions

The caller must have read and write permissions for the mirrored catalog.

Required Delegated Scopes

Item.ReadWrite.All

Limitations

  • The scope in the definition payload must be a Selectable namespace as returned by the List Scopes API.
  • The sourceType and connectionId properties are immutable and cannot be changed after item creation.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredCatalogs/{mirroredCatalogId}/updateDefinition
With optional parameters: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredCatalogs/{mirroredCatalogId}/updateDefinition?updateMetadata={updateMetadata}

URI Parameters

Name In Required Type Description
mirroredCatalogId
 path True

string (uuid)

The MirroredCatalog ID.
workspaceId
 path True

string (uuid)

The workspace ID.
updateMetadata
 query

boolean

When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the .platform file

Request Body

Name Required Type Description
definition True

MirroredCatalogDefinition

Mirrored catalog public definition object. Refer to Mirrored Catalog definition article for more details.

Responses

Name Type Description
200 OK

Request completed successfully.
202 Accepted

Request accepted. Update definition is in progress.

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

The service rate limit was exceeded. The server returns a Retry-After header indicating, in seconds, how long the client must wait before sending additional requests.

Headers

Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • OperationNotSupportedForItem - Operation not supported for requested item.

  • CorruptedPayload - The provided payload is corrupted.

Examples

Update a MirroredCatalog public definition example

Sample request

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

{
  "definition": {
    "parts": [
      {
        "path": "MirroredCatalogDefinition.json",
        "payload": "eyIkc2NoZW1hIjoiaHR0cHM6Ly9kZXZlbG9wZXIubWljcm9zb2Z0LmNvbS9qc29uLXNjaGVtYXMvZmFicmljL2l0ZW0vbWlycm9yZWRDYXRhbG9nL2RlZmluaXRpb24vbWlycm9yZWRDYXRhbG9nRGVmaW5pdGlvbi8xLjAuMC9zY2hlbWEuanNvbiIsInByb3BlcnRpZXMiOnsic291cmNlIjp7InR5cGUiOiJEcmVtaW9JY2ViZXJnQ2F0YWxvZyIsInR5cGVQcm9wZXJ0aWVzIjp7ImNvbm5lY3Rpb25JZCI6IjRlYjZiNzY3LWU3ODYtNDVlZC1iN2NmLWQyNTAyM2U1MjIyMiIsInNjb3BlIjpbIkFjY291bnRpbmciLCJVUyJdfX0sIm1vdW50ZWRUYWJsZXMiOlt7InNvdXJjZSI6eyJ0eXBlUHJvcGVydGllcyI6eyJmdWxseVF1YWxpZmllZFNjb3BlIjpbIkFjY291bnRpbmciLCJVUyIsIlRheGVzIl0sInRhYmxlTmFtZSI6IlRheEluZm8ifX19LHsic291cmNlIjp7InR5cGVQcm9wZXJ0aWVzIjp7ImZ1bGx5UXVhbGlmaWVkU2NvcGUiOlsiQWNjb3VudGluZyIsIlVTIiwiVGF4ZXMiXSwidGFibGVOYW1lIjoiTmV3VGFibGUifX19LHsic291cmNlIjp7InR5cGVQcm9wZXJ0aWVzIjp7ImZ1bGx5UXVhbGlmaWVkU2NvcGUiOlsiQWNjb3VudGluZyIsIlVTIiwiUmVjZWl2YWJsZSJdLCJ0YWJsZU5hbWUiOiJJbnZvaWNlcyJ9fX0seyJzb3VyY2UiOnsidHlwZVByb3BlcnRpZXMiOnsiZnVsbHlRdWFsaWZpZWRTY29wZSI6WyJBY2NvdW50aW5nIiwiVVMiLCJSZWNlaXZhYmxlIl0sInRhYmxlTmFtZSI6IlBheWFibGVzIn19fV19fQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:
200
Status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/ea72fc0b-5e31-44b0-b48f-add98bff6cdb
x-ms-operation-id: ea72fc0b-5e31-44b0-b48f-add98bff6cdb
Retry-After: 30

Definitions

Name Description
ErrorParameter

A structured parameter providing additional machine-readable context about an error.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
MirroredCatalogDefinition

Mirrored catalog public definition object. Refer to Mirrored Catalog definition article for more details.
MirroredCatalogDefinitionPart

Mirrored catalog definition part object.
PayloadType

The type of the definition part payload. Additional payload types may be added over time.
UpdateMirroredCatalogDefinitionRequest

Update mirrored catalog public definition request payload.

ErrorParameter

Object

A structured parameter providing additional machine-readable context about an error.

Name Type Description
message

string

A human-readable description of the parameter's meaning.
name

string

The parameter identifier.
value

string

The parameter value.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
isRetriable

boolean

When true, the request can be retried. Use the Retry-After response header to determine the delay, if available.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
parameters

ErrorParameter[]

Structured parameters providing additional machine-readable context about the error.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string (uuid)

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
parameters

ErrorParameter[]

Structured parameters providing additional machine-readable context about the error.
relatedResource

ErrorRelatedResource

The error related resource details.

MirroredCatalogDefinition

Object

Mirrored catalog public definition object. Refer to Mirrored Catalog definition article for more details.

Name Type Description
format

string

The format of the mirrored catalog definition.
parts

MirroredCatalogDefinitionPart[]

A list of definition parts.

MirroredCatalogDefinitionPart

Object

Mirrored catalog definition part object.

Name Type Description
path

string

The mirrored catalog definition part path.
payload

string

The mirrored catalog definition part payload.
payloadType

PayloadType

The payload type.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value Description
InlineBase64

Inline Base 64.

UpdateMirroredCatalogDefinitionRequest

Object

Update mirrored catalog public definition request payload.

Name Type Description
definition

MirroredCatalogDefinition

Mirrored catalog public definition object. Refer to Mirrored Catalog definition article for more details.