Git - Create Workspace Relation

Usługa:

Core

Wersja interfejsu API:

v1

Tworzy relację obszaru roboczego między określonym obszarem roboczym a powiązanym obszarem roboczym.

Note

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Tworzy relację rozgałęziania między obszarem roboczym gałęzi a jej podstawowym obszarem roboczym.

Permissions

Obiekt wywołujący musi mieć rolę administratora w obszarze roboczym gałęzi oraz rolę współautora lub wyższego poziomu w podstawowym obszarze roboczym.

Wymagane zakresy delegowane

Przestrzeń robocza.OdczytZapis.Wszystko

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity	Support
User	Yes
Główne usługi i Tożsamości zarządzane	Yes

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Treść żądania

Nazwa	Wymagane	Typ	Opis
relatedWorkspaceId	True	string (uuid)	Identyfikator powiązanego obszaru roboczego.
relationType	True	WorkspaceRelationType	Typ powiązanego obszaru roboczego do utworzenia w relacji. Tylko Base i Branch są prawidłowe do utworzenia.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	WorkspaceRelation	Pomyślnie utworzono.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień obszaru roboczego. WorkspaceNotFound — nie można odnaleźć określonego obszaru roboczego. WorkspaceRelationAlreadyExists — relacja między określonymi obszarami roboczymi już istnieje. WorkspaceRelationBidirectionalExists — relacja między tymi obszarami roboczymi już istnieje w przeciwnym kierunku. WorkspaceRelationInvalidArgument — nieprawidłowe argumenty podane dla operacji relacji obszaru roboczego. WorkspaceRelationInvalidType — nieprawidłowy typ relacji obszaru roboczego. WorkspaceRelationSelfReferencing — obszar roboczy nie może być powiązany z samym sobą. WorkspaceRelationBaseIsBranch — podstawowy obszar roboczy jest już gałęzią innego obszaru roboczego. WorkspaceRelationTargetHasBranches — docelowy obszar roboczy ma już obszary robocze gałęzi. WorkspaceRelationDifferentBase — docelowy obszar roboczy ma inny podstawowy obszar roboczy. WorkspaceRelationRootDirectoryMismatch — obszary robocze nie są połączone z tym samym katalogiem głównym repozytorium Git.

Przykłady

Create a workspace relation example

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

201

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

Definicje

Nazwa	Opis
CreateWorkspaceRelationRequest	Ładunek żądania do tworzenia relacji obszaru roboczego.
ErrorRelatedResource	Obiekt szczegółowych informacji o zasobie związanym z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
WorkspaceRelation	Obiekt relacji obszaru roboczego.
WorkspaceRelationType	Typ powiązanego obszaru roboczego w relacji. Dodatkowe powiązane typy obszarów roboczych można dodawać w czasie.

CreateWorkspaceRelationRequest

Objekt

Ładunek żądania do tworzenia relacji obszaru roboczego.

Nazwa	Typ	Opis
relatedWorkspaceId	string (uuid)	Identyfikator powiązanego obszaru roboczego.
relationType	WorkspaceRelationType	Typ powiązanego obszaru roboczego do utworzenia w relacji. Tylko Base i Branch są prawidłowe do utworzenia.

ErrorRelatedResource

Objekt

Obiekt szczegółowych informacji o zasobie związanym z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu powiązany z błędem.
resourceType	string	Typ zasobu powiązanego z błędem.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

WorkspaceRelation

Objekt

Obiekt relacji obszaru roboczego.

Nazwa	Typ	Opis
id	string (uuid)	Identyfikator relacji obszaru roboczego.
relatedWorkspaceId	string (uuid)	Identyfikator powiązanego obszaru roboczego.
relationType	WorkspaceRelationType	Typ powiązanego obszaru roboczego w relacji.
workspaceId	string (uuid)	Identyfikator przestrzeni roboczej.

WorkspaceRelationType

Wyliczenie

Typ powiązanego obszaru roboczego w relacji. Dodatkowe powiązane typy obszarów roboczych można dodawać w czasie.

Wartość	Opis
Base	Powiązany obszar roboczy jest podstawowym (źródłowym) obszarem roboczym.
Branch	Powiązany obszar roboczy jest obszarem roboczym gałęzi.
RelatedWorkspace	Powiązany obszar roboczy ma ogólną relację.