Git - List Workspace Relations

Dienst:

Core

API-Version:

v1

Gibt eine Liste der Arbeitsbereichsbeziehungen für den angegebenen Arbeitsbereich zurück.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Diese API unterstützt Paginierung.

Erlaubnisse

Der Anrufer muss über eine Viewer - oder höhere Arbeitsbereichsrolle verfügen.

Erforderliche delegierte Zugriffsbereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity	Support
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Interface

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
continuationToken	query		string	Ein Token zum Abrufen der nächsten Seite mit Ergebnissen.

Antworten

Name	Typ	Beschreibung
200 OK	WorkspaceRelations	Der Auftrag wurde erfolgreich abgeschlossen.
429 Too Many Requests	ErrorResponse	Der Dienstratenlimit wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: InsufficientPrivileges – Der Aufrufer verfügt nicht über ausreichende Arbeitsbereichsberechtigungen. WorkspaceNotFound – Der angegebene Arbeitsbereich wurde nicht gefunden.

Beispiele

List workspace relations example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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"
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
WorkspaceRelation	Ein Arbeitsbereichsbeziehungsobjekt.
WorkspaceRelations	Eine Liste der Arbeitsbereichsbeziehungen.
WorkspaceRelationType	Der Typ des verknüpften Arbeitsbereichs in der Beziehung. Weitere verwandte Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Objekt der fehlerbezogenen Ressourcendetails.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den Retry-After Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine menschenlesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine menschenlesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

WorkspaceRelation

Objekt

Ein Arbeitsbereichsbeziehungsobjekt.

Name	Typ	Beschreibung
id	string (uuid)	Die Arbeitsbereichsbeziehungs-ID.
relatedWorkspaceId	string (uuid)	Die zugehörige Arbeitsbereichs-ID.
relationType	WorkspaceRelationType	Der Typ des verknüpften Arbeitsbereichs in der Beziehung.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID.

WorkspaceRelations

Objekt

Eine Liste der Arbeitsbereichsbeziehungen.

Name	Typ	Beschreibung
continuationToken	string	Das Token für den nächsten Resultsetbatch. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
continuationUri	string	Der URI des nächsten Resultsetbatches. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
value	WorkspaceRelation[]	Eine Liste der Arbeitsbereichsbeziehungen.

WorkspaceRelationType

Enumeration

Der Typ des verknüpften Arbeitsbereichs in der Beziehung. Weitere verwandte Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Base	Der zugehörige Arbeitsbereich ist der Basisarbeitsbereich (Quellarbeitsbereich).
Branch	Der zugehörige Arbeitsbereich ist ein Verzweigungsarbeitsbereich.
RelatedWorkspace	Der zugehörige Arbeitsbereich hat eine allgemeine Beziehung.