Git - List Workspace Relations

Usługa:: Core

Wersja interfejsu API:: v1

Zwraca listę relacji obszaru roboczego dla określonego obszaru roboczego.

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.

Ten interfejs API obsługuje stronicowanie.

Permissions

Obiekt wywołujący musi mieć rolę przeglądającego lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

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

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
continuationToken	query		string	Token do pobierania następnej strony wyników.

Odpowiedzi

Nazwa Typ Opis

200 OK

Nazwa	Typ	Opis
200 OK	WorkspaceRelations	Żądanie zostało ukończone pomyślnie.
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.

WorkspaceRelations

Żądanie zostało ukończone pomyślnie.

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.

Przykłady

List workspace relations example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
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.
WorkspaceRelations	Lista relacji obszaru roboczego.
WorkspaceRelationType	Typ powiązanego obszaru roboczego w relacji. Dodatkowe powiązane typy obszarów roboczych można dodawać w czasie.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwa	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

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.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
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.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
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.

WorkspaceRelations

Objekt

Lista relacji obszaru roboczego.

Nazwa	Typ	Opis
continuationToken	string	Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri	string	Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
value	WorkspaceRelation[]	Lista relacji obszaru roboczego.

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