Git - List Workspace Relations

Servizio:: Core

Versione API:: v1

Restituisce un elenco di relazioni tra aree di lavoro per l'area di lavoro specificata.

Note

Questa API fa parte di una versione di anteprima e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione.

Questa API supporta paginazione.

Permissions

Il chiamante deve avere un ruolo visualizzatore o superiore dell'area di lavoro.

Ambiti delegati obbligatori

Workspace.Read.All o Workspace.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identity	Support
User	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
continuationToken	query		string	Token per il recupero della pagina successiva dei risultati.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	WorkspaceRelations	Richiesta completata correttamente.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro. WorkspaceNotFound: l'area di lavoro specificata non è stata trovata.

WorkspaceRelations

Richiesta completata correttamente.

429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer

Other Status Codes

ErrorResponse

Codici di errore comuni:

InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro.
WorkspaceNotFound: l'area di lavoro specificata non è stata trovata.

Esempio

List workspace relations example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
    }
  ]
}

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
WorkspaceRelation	Oggetto relazione dell'area di lavoro.
WorkspaceRelations	Elenco delle relazioni tra aree di lavoro.
WorkspaceRelationType	Tipo dell'area di lavoro correlata nella relazione. È possibile aggiungere altri tipi di area di lavoro correlati nel tempo.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

WorkspaceRelation

Oggetto

Oggetto relazione dell'area di lavoro.

Nome	Tipo	Descrizione
id	string (uuid)	ID relazione dell'area di lavoro.
relatedWorkspaceId	string (uuid)	ID dell'area di lavoro correlata.
relationType	WorkspaceRelationType	Tipo dell'area di lavoro correlata nella relazione.
workspaceId	string (uuid)	L’ID dell’area di lavoro.

WorkspaceRelations

Oggetto

Elenco delle relazioni tra aree di lavoro.

Nome	Tipo	Descrizione
continuationToken	string	Token per il batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
continuationUri	string	URI del batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
value	WorkspaceRelation[]	Elenco delle relazioni tra aree di lavoro.

WorkspaceRelationType

Enumerazione

Tipo dell'area di lavoro correlata nella relazione. È possibile aggiungere altri tipi di area di lavoro correlati nel tempo.

Valore	Descrizione
Base	L'area di lavoro correlata è l'area di lavoro di base (origine).
Branch	L'area di lavoro correlata è un'area di lavoro del ramo.
RelatedWorkspace	L'area di lavoro correlata ha una relazione generale.