Git - List Workspace Relations

Service:
Core
Version d’API:
v1

Retourne une liste de relations d’espace de travail pour l’espace de travail spécifié.

Note

Cette API fait partie d’une préversion et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production.

Cette API prend en charge pagination.

Permissions

L’appelant doit avoir un rôle de visionneuse ou d’espace de travail supérieur.

Étendues déléguées requises

Workspace.Read.All ou Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity Support
Utilisateur Oui
Service principal et identités gérées Oui

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations
Avec des paramètres facultatifs: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations?continuationToken={continuationToken}

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.
continuationToken
 query

string

Jeton permettant de récupérer la page suivante des résultats.

Réponses

Nom Type Description
200 OK

WorkspaceRelations

La demande s’est terminée avec succès.
429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • InsufficientPrivileges : l’appelant ne dispose pas des autorisations d’espace de travail suffisantes.

  • WorkspaceNotFound : l’espace de travail spécifié est introuvable.

Exemples

List workspace relations example

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
    }
  ]
}

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
WorkspaceRelation

Objet relation d’espace de travail.
WorkspaceRelations

Liste des relations d’espace de travail.
WorkspaceRelationType

Type de l’espace de travail associé dans la relation. Des types d’espace de travail associés supplémentaires peuvent être ajoutés au fil du temps.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable

boolean

Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête Retry-After de réponse pour déterminer le délai, le cas échéant.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string (uuid)

ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

WorkspaceRelation

Objet

Objet relation d’espace de travail.

Nom Type Description
id

string (uuid)

ID de relation de l’espace de travail.
relatedWorkspaceId

string (uuid)

ID d’espace de travail associé.
relationType

WorkspaceRelationType

Type de l’espace de travail associé dans la relation.
workspaceId

string (uuid)

Identifiant de l’espace de travail.

WorkspaceRelations

Objet

Liste des relations d’espace de travail.

Nom Type Description
continuationToken

string

Jeton du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
continuationUri

string

URI du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
value

WorkspaceRelation[]

Liste des relations d’espace de travail.

WorkspaceRelationType

Énumération

Type de l’espace de travail associé dans la relation. Des types d’espace de travail associés supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Base

L’espace de travail associé est l’espace de travail de base (source).
Branch

L’espace de travail associé est un espace de travail de branche.
RelatedWorkspace

L’espace de travail associé a une relation générale.