Git - List Workspace Relations

Service:
Core
API-versie:
v1

Retourneert een lijst met werkruimterelaties voor de opgegeven werkruimte.

Note

Deze API maakt deel uit van een preview-versie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik.

Deze API ondersteunt paginering.

Permissions

De beller moet een viewer of een hogere werkruimterol hebben.

Vereiste gedelegeerde bevoegdheden

Workspace.Read.All of Workspace.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identity Support
User Ja
serviceprincipal en beheerde identiteiten Ja

Interface

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

URI-parameters

Name In Vereist Type Description
workspaceId
 path True

string (uuid)

De werkruimte-ID.
continuationToken
 query

string

Een token voor het ophalen van de volgende pagina met resultaten.

Antwoorden

Name Type Description
200 OK

WorkspaceRelations

De aanvraag is voltooid.
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • InsufficientPrivileges : de aanroeper beschikt niet over voldoende werkruimtemachtigingen.

  • WorkspaceNotFound: de opgegeven werkruimte is niet gevonden.

Voorbeelden

List workspace relations example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

De foutreactie.
ErrorResponseDetails

De details van het foutbericht.
WorkspaceRelation

Een relationeel object voor werkruimten.
WorkspaceRelations

Een lijst met werkruimterelaties.
WorkspaceRelationType

Het type van de gerelateerde werkruimte in de relatie. Er kunnen na verloop van tijd extra gerelateerde werkruimtetypen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-ID die betrokken is bij het probleem.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

De foutreactie.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.

WorkspaceRelation

Object

Een relationeel object voor werkruimten.

Name Type Description
id

string (uuid)

De relatie-id van de werkruimte.
relatedWorkspaceId

string (uuid)

De gerelateerde werkruimte-id.
relationType

WorkspaceRelationType

Het type van de gerelateerde werkruimte in de relatie.
workspaceId

string (uuid)

De werkruimte-ID.

WorkspaceRelations

Object

Een lijst met werkruimterelaties.

Name Type Description
continuationToken

string

Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri

string

De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value

WorkspaceRelation[]

Een lijst met werkruimterelaties.

WorkspaceRelationType

Opsomming

Het type van de gerelateerde werkruimte in de relatie. Er kunnen na verloop van tijd extra gerelateerde werkruimtetypen worden toegevoegd.

Waarde Description
Base

De gerelateerde werkruimte is de basiswerkruimte (bronwerkruimte).
Branch

De gerelateerde werkruimte is een vertakkingswerkruimte.
RelatedWorkspace

De gerelateerde werkruimte heeft een algemene relatie.