Git - List Workspace Relations

Tjänst:: Core

API-version:: v1

Returnerar en lista över arbetsyterelationer för den angivna arbetsytan.

Note

Det här API:et är en del av en förhandsversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning.

Det här API:et stöder sidnumrering.

Permissions

Anroparen måste ha en visningsroll eller en högre arbetsyteroll.

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity	Support
User	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Interface

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string (uuid)	Arbetsyte-ID.
continuationToken	query		string	En token för att hämta nästa sida med resultat.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	WorkspaceRelations	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InsufficientPrivileges – anroparen har inte tillräcklig behörighet för arbetsytan. WorkspaceNotFound – Den angivna arbetsytan hittades inte.

WorkspaceRelations

Begäran har slutförts.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

InsufficientPrivileges – anroparen har inte tillräcklig behörighet för arbetsytan.
WorkspaceNotFound – Den angivna arbetsytan hittades inte.

Exempel

List workspace relations example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Detaljer om felsvaret.
WorkspaceRelation	Ett arbetsyterelationsobjekt.
WorkspaceRelations	En lista över arbetsyterelationer.
WorkspaceRelationType	Typen av relaterad arbetsyta i relationen. Ytterligare relaterade arbetsytetyper kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Resurs-ID:t som är inblandat i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.

WorkspaceRelation

Objekt

Ett arbetsyterelationsobjekt.

Name	Typ	Description
id	string (uuid)	Arbetsytans relations-ID.
relatedWorkspaceId	string (uuid)	Det relaterade arbetsyte-ID:t.
relationType	WorkspaceRelationType	Typen av relaterad arbetsyta i relationen.
workspaceId	string (uuid)	Arbetsyte-ID.

WorkspaceRelations

Objekt

En lista över arbetsyterelationer.

Name	Typ	Description
continuationToken	string	Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri	string	URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
value	WorkspaceRelation[]	En lista över arbetsyterelationer.

WorkspaceRelationType

Uppräkning

Typen av relaterad arbetsyta i relationen. Ytterligare relaterade arbetsytetyper kan läggas till över tid.

Värde	Description
Base	Den relaterade arbetsytan är basarbetsytan (källan).
Branch	Den relaterade arbetsytan är en grenarbetsyta.
RelatedWorkspace	Den relaterade arbetsytan har en allmän relation.