Edit

Staging - Delete Datasource Element

Service:
DataAgent
API Version:
v1

Deletes a schema element that is no longer present in the live schema from a staging datasource.

Note

Data Agent configuration management is currently in Preview (learn more).

Use this API to remove a stale element from the saved datasource schema after it has been removed from the live datasource schema. This API does not automatically remove elements when the live schema changes, so callers can review the change and decide whether to delete the saved element themselves.

An element can be deleted only when it is no longer present in the live datasource schema. If the element still exists in the live datasource schema, the request fails.

Permissions

The caller must have read and write permissions for the DataAgent.

Required Delegated Scopes

Item.ReadWrite.All or DataAgent.ReadWrite.All

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

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/elements?id={id}

URI Parameters

Name In Required Type Description
dataAgentId
 path True

string (uuid)

The DataAgent ID.
datasourceId
 path True

string (uuid)

The datasource ID.
workspaceId
 path True

string (uuid)

The workspace ID.
id
 query True

string

The element identifier.

Responses

Name Type Description
200 OK

Request completed successfully.
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:

  • ItemNotFound - The requested item was not found.

  • ElementStillAvailable - The element still exists in the datasource schema and cannot be deleted.

Examples

Delete staging DataAgent datasource element example

Sample request

DELETE https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/datasources/c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30/elements?id=U2NoZW1hcy9kYm8vVGFibGVzL1RyaXA=

Sample response

Status code:
200

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

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.
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.
relatedResource

ErrorRelatedResource

The error related resource details.