Git - Delete Workspace Relation

Service:

Core

API Version:

v1

Deletes a workspace relation.

Note

This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.

Deletes an existing workspace relation between two workspaces, identified by the relation ID. The provided workspace ID can be either a base workspace or a branch workspace.

Permissions

The caller must have an admin workspace role on the specified workspace.

Required Delegated Scopes

Workspace.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}/git/workspaceRelations/{workspaceRelationId}

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string (uuid)	The workspace ID.
workspaceRelationId	path	True	string (uuid)	The workspace relation ID.

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: InsufficientPrivileges - The caller does not have sufficient workspace permissions. WorkspaceNotFound - The specified workspace was not found. WorkspaceRelationNotFound - The specified workspace relation was not found. WorkspaceNotInvolvedInRelation - The workspace is not involved in the specified relation. WorkspaceRelationTypeNotBranch - The relation is not a branch relation and cannot be deleted through this endpoint.

Examples

Delete a workspace relation example

Sample request

HTTP

DELETE https://api.fabric.microsoft.com/v1/workspaces/55555555-5555-5555-5555-555555555555/git/workspaceRelations/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa

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.