Git - List Workspace Relations

Služba:

Core

Verze rozhraní API:

v1

Vrátí seznam vztahů pracovního prostoru pro zadaný pracovní prostor.

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í.

Toto rozhraní API podporuje stránkování.

Povolení

Volající musí mít roli čtenáře nebo vyššího pracovního prostoru.

Požadované delegované rozsahy

Workspace.Read.All nebo 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í

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

S volitelnými parametry:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations?continuationToken={continuationToken}

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	Identifikátor pracovního prostoru.
continuationToken	query		string	Token pro načtení další stránky výsledků.

Odpovědi

Název	Typ	Description
200 OK	WorkspaceRelations	Žádost byla úspěšně dokončena.
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.

Příklady

List workspace relations example

Ukázkový požadavek

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/66666666-6666-6666-6666-666666666666/git/workspaceRelations

Ukázková odpověď

Stavový kód:

200

{
  "value": [
    {
      "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "88888888-8888-8888-8888-888888888888",
      "relationType": "Base"
    },
    {
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "22222222-2222-2222-2222-222222222222",
      "relationType": "RelatedWorkspace"
    },
    {
      "id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "44444444-4444-4444-4444-444444444444",
      "relationType": "RelatedWorkspace"
    }
  ]
}

Definice

Název	Description
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.
WorkspaceRelations	Seznam vztahů 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ů.

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.

WorkspaceRelations

Objekt

Seznam vztahů pracovního prostoru.

Název	Typ	Description
continuationToken	string	Token pro další dávku sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
continuationUri	string	Identifikátor URI další dávky sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
value	WorkspaceRelation[]	Seznam vztahů 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.