Git - Create Workspace Relation

Služba:

Core

Verze rozhraní API:

v1

Vytvoří vztah pracovního prostoru mezi zadaným pracovním prostorem a souvisejícím pracovním prostorem.

Note

Toto rozhraní API je součástí verze Preview a poskytuje se pouze pro účely vyhodnocení a vývoje. Může se změnit na základě zpětné vazby a nedoporučuje se pro produkční použití.

Vytvoří vztah větvení mezi pracovním prostorem větve a jeho základním pracovním prostorem.

Povolení

Volající musí mít roli správce v pracovním prostoru větve a roli přispěvatele nebo vyšší v základním pracovním prostoru.

Požadované delegované rozsahy

Workspace.ReadWrite.All

Podporované identity v Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identity	Podpora
User	Ano
Hlavní služba a Spravované identity	Ano

Rozhraní

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

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	Identifikátor pracovního prostoru.

Text požadavku

Název	Vyžadováno	Typ	Description
relatedWorkspaceId	True	string (uuid)	ID souvisejícího pracovního prostoru.
relationType	True	WorkspaceRelationType	Typ souvisejícího pracovního prostoru, který se má vytvořit ve vztahu. Pouze Base a Branch jsou platné pro vytvoření.

Odpovědi

Název	Typ	Description
201 Created	WorkspaceRelation	Úspěšně se vytvořilo.
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku Retry-After udávající, kolik sekund musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: InsufficientPrivileges – Volající nemá dostatečná oprávnění pracovního prostoru. WorkspaceNotFound – Zadaný pracovní prostor nebyl nalezen. WorkspaceRelationAlreadyExists – Vztah mezi zadanými pracovními prostory již existuje. WorkspaceRelationBidirectionalExists – Vztah mezi těmito pracovními prostory již existuje v opačném směru. WorkspaceRelationInvalidArgument – neplatné argumenty zadané pro operaci relace pracovního prostoru. WorkspaceRelationInvalidType – Neplatný typ relace pracovního prostoru WorkspaceRelationSelfReferencing – Pracovní prostor nemůže souviset se sebou. WorkspaceRelationBaseIsBranch – Základní pracovní prostor je již větví jiného pracovního prostoru. WorkspaceRelationTargetHasBranches – cílový pracovní prostor už má pracovní prostory větví. WorkspaceRelationDifferentBase – cílový pracovní prostor má jiný základní pracovní prostor. WorkspaceRelationRootDirectoryMismatch – Pracovní prostory nejsou připojené ke stejnému kořenovému adresáři úložiště Git.

Příklady

Create a workspace relation example

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

201

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

Definice

Název	Description
CreateWorkspaceRelationRequest	Datová část požadavku pro vytvoření relace pracovního prostoru.
ErrorParameter	Strukturovaný parametr poskytující další strojově čitelný kontext chyby.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
WorkspaceRelation	Relační objekt pracovního prostoru.
WorkspaceRelationType	Typ souvisejícího pracovního prostoru ve vztahu. V průběhu času je možné přidat další související typy pracovních prostorů.

CreateWorkspaceRelationRequest

Objekt

Datová část požadavku pro vytvoření relace pracovního prostoru.

Název	Typ	Description
relatedWorkspaceId	string (uuid)	ID souvisejícího pracovního prostoru.
relationType	WorkspaceRelationType	Typ souvisejícího pracovního prostoru, který se má vytvořit ve vztahu. Pouze Base a Branch jsou platné pro vytvoření.

ErrorParameter

Objekt

Strukturovaný parametr poskytující další strojově čitelný kontext chyby.

Název	Typ	Description
message	string	Popis významu parametru čitelný člověkem.
name	string	Identifikátor parametru.
value	string	Hodnota parametru.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Název	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který se podílí na chybě.

ErrorResponse

Objekt

Odpověď na chybu.

Název	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable	boolean	Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky Retry-After odpovědi určete zpoždění, pokud je k dispozici.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
parameters	ErrorParameter[]	Strukturované parametry poskytují další strojově čitelný kontext chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Název	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
parameters	ErrorParameter[]	Strukturované parametry poskytují další strojově čitelný kontext chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

WorkspaceRelation

Objekt

Relační objekt pracovního prostoru.

Název	Typ	Description
id	string (uuid)	ID relace pracovního prostoru.
relatedWorkspaceId	string (uuid)	ID souvisejícího pracovního prostoru.
relationType	WorkspaceRelationType	Typ souvisejícího pracovního prostoru ve vztahu.
workspaceId	string (uuid)	Identifikátor pracovního prostoru.

WorkspaceRelationType

Výčet

Typ souvisejícího pracovního prostoru ve vztahu. V průběhu času je možné přidat další související typy pracovních prostorů.

Hodnota	Description
Base	Související pracovní prostor je základní (zdrojový) pracovní prostor.
Branch	Související pracovní prostor je pracovní prostor větve.
RelatedWorkspace	Související pracovní prostor má obecný vztah.