Git - List Workspace Relations

Serviço:: Core

Versão da API:: v1

Retorna uma lista de relações de workspace para o workspace especificado.

Note

Essa API faz parte de uma versão prévia e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção.

Essa API dá suporte a de paginação.

Permissões

O chamador deve ter uma função de workspace superior ou visualizador .

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identity	Suporte
Usuário	Sim
Entidade de serviço e identidades gerenciadas	Sim

Interface

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.
continuationToken	query		string	Um token para recuperar a próxima página de resultados.

Respostas

Nome Tipo Description

200 OK

Nome	Tipo	Description
200 OK	WorkspaceRelations	Solicitação concluída com êxito.
429 Too Many Requests	ErrorResponse	O limite de taxa de serviço foi excedido. O servidor retorna um `Retry-After` cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InsufficientPrivileges - O chamador não tem permissões de workspace suficientes. WorkspaceNotFound – O workspace especificado não foi encontrado.

WorkspaceRelations

Solicitação concluída com êxito.

429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais.

Cabeçalhos

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InsufficientPrivileges - O chamador não tem permissões de workspace suficientes.
WorkspaceNotFound – O workspace especificado não foi encontrado.

Exemplos

List workspace relations example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
    }
  ]
}

Definições

Nome	Description
ErrorRelatedResource	O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
WorkspaceRelation	Um objeto de relação de workspace.
WorkspaceRelations	Uma lista de relações de workspace.
WorkspaceRelationType	O tipo do workspace relacionado na relação. Tipos de workspace relacionados adicionais podem ser adicionados ao longo do tempo.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome	Tipo	Description
resourceId	string	O identificador do recurso envolvido no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
isRetriable	boolean	Quando true, a solicitação pode ser repetida. Use o `Retry-After` cabeçalho de resposta para determinar o atraso, se disponível.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

WorkspaceRelation

Objeto

Um objeto de relação de workspace.

Nome	Tipo	Description
id	string (uuid)	A ID da relação do workspace.
relatedWorkspaceId	string (uuid)	A ID do workspace relacionado.
relationType	WorkspaceRelationType	O tipo do workspace relacionado na relação.
workspaceId	string (uuid)	O identificador do espaço de trabalho.

WorkspaceRelations

Objeto

Uma lista de relações de workspace.

Nome	Tipo	Description
continuationToken	string	O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value	WorkspaceRelation[]	Uma lista de relações de workspace.

WorkspaceRelationType

Enumeração

O tipo do workspace relacionado na relação. Tipos de workspace relacionados adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Base	O workspace relacionado é o workspace base (origem).
Branch	O workspace relacionado é um workspace de branch.
RelatedWorkspace	O workspace relacionado tem uma relação geral.