Git - List Workspace Relations

Serviço:

Core

Versão da API:

v1

Devolve uma lista de relações de espaço de trabalho para o espaço de trabalho especificado.

Note

Esta API faz parte de uma versão de pré-visualização e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção.

Esta API suporta paginação.

Permissions

O interlocutor deve ter um visualizador ou um papel superior no espaço de trabalho.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identity	Suporte
User	Sim
Entidade de serviço e identidades geridas	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 do URI

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

Respostas

Name	Tipo	Descrição
200 OK	WorkspaceRelations	Pedido concluído com sucesso.
429 Too Many Requests	ErrorResponse	O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InsufficientPrivileges - O chamador não tem permissões de espaço de trabalho suficientes. WorkspaceNotFound - O espaço de trabalho especificado não foi encontrado.

Exemplos

List workspace relations example

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Name	Descrição
ErrorRelatedResource	Os detalhes do objeto de recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes do erro na resposta.
WorkspaceRelation	Um objeto de relação de espaço de trabalho.
WorkspaceRelations	Uma lista de relações com o espaço de trabalho.
WorkspaceRelationType	O tipo do espaço de trabalho relacionado na relação. Tipos adicionais de espaços de trabalho relacionados podem ser adicionados ao longo do tempo.

ErrorRelatedResource

Object

Os detalhes do objeto de recurso relacionado ao erro.

Name	Tipo	Descrição
resourceId	string	O ID do recurso envolvido no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

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

ErrorResponseDetails

Object

Os detalhes do erro na resposta.

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

WorkspaceRelation

Object

Um objeto de relação de espaço de trabalho.

Name	Tipo	Descrição
id	string (uuid)	O ID de relação do espaço de trabalho.
relatedWorkspaceId	string (uuid)	O ID do espaço de trabalho relacionado.
relationType	WorkspaceRelationType	O tipo do espaço de trabalho relacionado na relação.
workspaceId	string (uuid)	O ID do espaço de trabalho.

WorkspaceRelations

Object

Uma lista de relações com o espaço de trabalho.

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

WorkspaceRelationType

Enumeração

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

Valor	Descrição
Base	O espaço de trabalho relacionado é o espaço de trabalho base (fonte).
Branch	O espaço de trabalho relacionado é um espaço de trabalho ramificado.
RelatedWorkspace	O espaço de trabalho relacionado tem uma relação geral.