Git - List Workspace Relations

Tjeneste:: Core

API-version:: v1

Returnerer en liste over arbejdsområderelationer for det angivne arbejdsområde.

Bemærk

Denne API er en del af en prøveversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug.

Denne API understøtter sideinddeling.

Permissions

Den, der ringer op, skal have en fremviser eller en højere arbejdsområderolle.

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Id	Støtte
User	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

Med valgfrie parametre:

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
continuationToken	query		string	Et token til hentning af den næste side med resultater.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	WorkspaceRelations	Anmodningen blev fuldført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InsufficientPrivileges – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet. WorkspaceNotFound – Det angivne arbejdsområde blev ikke fundet.

WorkspaceRelations

Anmodningen blev fuldført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

InsufficientPrivileges – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet.
WorkspaceNotFound – Det angivne arbejdsområde blev ikke fundet.

Eksempler

List workspace relations example

Eksempelanmodning

HTTP

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

Eksempelsvar

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

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
WorkspaceRelation	Et objekt til arbejdsområderelation.
WorkspaceRelations	En liste over arbejdsområderelationer.
WorkspaceRelationType	Typen af det relaterede arbejdsområde i relationen. Der kan tilføjes flere relaterede arbejdsområdetyper over tid.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

WorkspaceRelation

Objekt

Et objekt til arbejdsområderelation.

Name	Type	Beskrivelse
id	string (uuid)	Relations-id'et for arbejdsområdet.
relatedWorkspaceId	string (uuid)	Det relaterede arbejdsområde-id.
relationType	WorkspaceRelationType	Typen af det relaterede arbejdsområde i relationen.
workspaceId	string (uuid)	Arbejdsområde-id'et.

WorkspaceRelations

Objekt

En liste over arbejdsområderelationer.

Name	Type	Beskrivelse
continuationToken	string	Tokenet for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
continuationUri	string	URI'en for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
value	WorkspaceRelation[]	En liste over arbejdsområderelationer.

WorkspaceRelationType

Optælling

Typen af det relaterede arbejdsområde i relationen. Der kan tilføjes flere relaterede arbejdsområdetyper over tid.

Værdi	Beskrivelse
Base	Det relaterede arbejdsområde er basisarbejdsområdet (kildearbejdsområdet).
Branch	Det relaterede arbejdsområde er et forgreningsarbejdsområde.
RelatedWorkspace	Det relaterede arbejdsområde har en generel relation.