Git - Create Workspace Relation

Service:
Core
API-versie:
v1

Hiermee maakt u een werkruimterelatie tussen de opgegeven werkruimte en een gerelateerde werkruimte.

Note

Deze API maakt deel uit van een preview-versie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik.

Hiermee maakt u een vertakkingsrelatie tussen een vertakkingswerkruimte en de bijbehorende basiswerkruimte.

Permissions

De aanroeper moet een beheerdersrol hebben in de vertakkingswerkruimte en een inzender of een hogere rol in de basiswerkruimte.

Vereiste gedelegeerde bevoegdheden

Workspace.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identity Support
User Ja
serviceprincipal en beheerde identiteiten Ja

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations

URI-parameters

Name In Vereist Type Description
workspaceId
 path True

string (uuid)

De werkruimte-ID.

Aanvraagbody

Name Vereist Type Description
relatedWorkspaceId True

string (uuid)

De gerelateerde werkruimte-id.
relationType True

WorkspaceRelationType

Het type van de gerelateerde werkruimte die moet worden gemaakt in de relatie. Alleen Base en Branch zijn geldig voor het maken.

Antwoorden

Name Type Description
201 Created

WorkspaceRelation

Gemaakt.
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • InsufficientPrivileges : de aanroeper beschikt niet over voldoende werkruimtemachtigingen.

  • WorkspaceNotFound: de opgegeven werkruimte is niet gevonden.

  • WorkspaceRelationAlreadyExists : er bestaat al een relatie tussen de opgegeven werkruimten.

  • WorkspaceRelationBidirectionalExists: er bestaat al een relatie tussen deze werkruimten in de tegenovergestelde richting.

  • WorkspaceRelationInvalidArgument : ongeldige argumenten die zijn opgegeven voor de bewerking van de werkruimterelatie.

  • WorkspaceRelationInvalidType - Ongeldig type werkruimterelatie.

  • WorkspaceRelationSelfReferencing: een werkruimte kan niet aan zichzelf zijn gerelateerd.

  • WorkspaceRelationBaseIsBranch: de basiswerkruimte is al een vertakking van een andere werkruimte.

  • WorkspaceRelationTargetHasBranches - De doelwerkruimte heeft al vertakkingswerkruimten.

  • WorkspaceRelationDifferentBase - De doelwerkruimte heeft een andere basiswerkruimte.

  • WorkspaceRelationRootDirectoryMismatch : de werkruimten zijn niet verbonden met dezelfde hoofdmap van de Git-opslagplaats.

Voorbeelden

Create a workspace relation example

Voorbeeldaanvraag

POST https://api.fabric.microsoft.com/v1/workspaces/55555555-5555-5555-5555-555555555555/git/workspaceRelations

{
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

Voorbeeldrespons

Statuscode:
201 
{
  "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "workspaceId": "55555555-5555-5555-5555-555555555555",
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

Definities

Name Description
CreateWorkspaceRelationRequest

De nettolading van de aanvraag voor het maken van een werkruimterelatie.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

De foutreactie.
ErrorResponseDetails

De details van het foutbericht.
WorkspaceRelation

Een relationeel object voor werkruimten.
WorkspaceRelationType

Het type van de gerelateerde werkruimte in de relatie. Er kunnen na verloop van tijd extra gerelateerde werkruimtetypen worden toegevoegd.

CreateWorkspaceRelationRequest

Object

De nettolading van de aanvraag voor het maken van een werkruimterelatie.

Name Type Description
relatedWorkspaceId

string (uuid)

De gerelateerde werkruimte-id.
relationType

WorkspaceRelationType

Het type van de gerelateerde werkruimte die moet worden gemaakt in de relatie. Alleen Base en Branch zijn geldig voor het maken.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-ID die betrokken is bij het probleem.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

De foutreactie.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.

WorkspaceRelation

Object

Een relationeel object voor werkruimten.

Name Type Description
id

string (uuid)

De relatie-id van de werkruimte.
relatedWorkspaceId

string (uuid)

De gerelateerde werkruimte-id.
relationType

WorkspaceRelationType

Het type van de gerelateerde werkruimte in de relatie.
workspaceId

string (uuid)

De werkruimte-ID.

WorkspaceRelationType

Opsomming

Het type van de gerelateerde werkruimte in de relatie. Er kunnen na verloop van tijd extra gerelateerde werkruimtetypen worden toegevoegd.

Waarde Description
Base

De gerelateerde werkruimte is de basiswerkruimte (bronwerkruimte).
Branch

De gerelateerde werkruimte is een vertakkingswerkruimte.
RelatedWorkspace

De gerelateerde werkruimte heeft een algemene relatie.