Git - Create Workspace Relation

Tjänst:
Core
API-version:
v1

Skapar en arbetsyterelation mellan den angivna arbetsytan och en relaterad arbetsyta.

Note

Det här API:et är en del av en förhandsversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning.

Skapar en förgreningsrelation mellan en grenarbetsyta och dess basarbetsyta.

Permissions

Anroparen måste ha en administratörsroll på grenarbetsytan och en deltagare eller en högre roll på basarbetsytan.

Obligatoriska delegerade omfång

Arbetsutrymme.LäsSkriv.Allt

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity Support
User Ja
Tjänsthuvudnamn och hanterade identiteter Ja

Interface

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

URI-parametrar

Name I Obligatorisk Typ Description
workspaceId
 path True

string (uuid)

Arbetsyte-ID.

Begärandetext

Name Obligatorisk Typ Description
relatedWorkspaceId True

string (uuid)

Det relaterade arbetsyte-ID:t.
relationType True

WorkspaceRelationType

Typen av relaterad arbetsyta som ska skapas i relationen. Endast Base och Branch är giltiga för skapande.

Svar

Name Typ Description
201 Created

WorkspaceRelation

Har skapats.
429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • InsufficientPrivileges – anroparen har inte tillräcklig behörighet för arbetsytan.

  • WorkspaceNotFound – Den angivna arbetsytan hittades inte.

  • WorkspaceRelationAlreadyExists – Det finns redan en relation mellan de angivna arbetsytorna.

  • WorkspaceRelationBidirectionalExists – Det finns redan en relation mellan dessa arbetsytor i motsatt riktning.

  • WorkspaceRelationInvalidArgument – Ogiltiga argument som angetts för arbetsyterelationsåtgärd.

  • WorkspaceRelationInvalidType – Ogiltig relationstyp för arbetsytor.

  • WorkspaceRelationSelfReferencing – En arbetsyta kan inte vara relaterad till sig själv.

  • WorkspaceRelationBaseIsBranch – basarbetsytan är redan en gren av en annan arbetsyta.

  • WorkspaceRelationTargetHasBranches – målarbetsytan har redan grenarbetsytor.

  • WorkspaceRelationDifferentBase – målarbetsytan har en annan basarbetsyta.

  • WorkspaceRelationRootDirectoryMismatch – Arbetsytorna är inte anslutna till samma Git-lagringsplatsrot.

Exempel

Create a workspace relation example

Exempelbegäran

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

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

Exempelsvar

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

Definitioner

Name Description
CreateWorkspaceRelationRequest

Nyttolasten för begäran för att skapa en arbetsyterelation.
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Detaljer om felsvaret.
WorkspaceRelation

Ett arbetsyterelationsobjekt.
WorkspaceRelationType

Typen av relaterad arbetsyta i relationen. Ytterligare relaterade arbetsytetyper kan läggas till över tid.

CreateWorkspaceRelationRequest

Objekt

Nyttolasten för begäran för att skapa en arbetsyterelation.

Name Typ Description
relatedWorkspaceId

string (uuid)

Det relaterade arbetsyte-ID:t.
relationType

WorkspaceRelationType

Typen av relaterad arbetsyta som ska skapas i relationen. Endast Base och Branch är giltiga för skapande.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Resurs-ID:t som är inblandat i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable

boolean

När det är sant kan begäran göras på nytt. Använd svarshuvudet Retry-After för att fastställa fördröjningen, om den är tillgänglig.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Detaljer om resursen relaterad till felet.
requestId

string (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Detaljer om resursen relaterad till felet.

WorkspaceRelation

Objekt

Ett arbetsyterelationsobjekt.

Name Typ Description
id

string (uuid)

Arbetsytans relations-ID.
relatedWorkspaceId

string (uuid)

Det relaterade arbetsyte-ID:t.
relationType

WorkspaceRelationType

Typen av relaterad arbetsyta i relationen.
workspaceId

string (uuid)

Arbetsyte-ID.

WorkspaceRelationType

Uppräkning

Typen av relaterad arbetsyta i relationen. Ytterligare relaterade arbetsytetyper kan läggas till över tid.

Värde Description
Base

Den relaterade arbetsytan är basarbetsytan (källan).
Branch

Den relaterade arbetsytan är en grenarbetsyta.
RelatedWorkspace

Den relaterade arbetsytan har en allmän relation.