Git - List Workspace Relations

Servicio:: Core

Versión de la API:: v1

Devuelve una lista de relaciones de área de trabajo para el área de trabajo especificada.

Note

Esta API forma parte de una versión preliminar y solo se proporciona con fines de evaluación y desarrollo. Puede cambiar en función de los comentarios y no se recomienda para su uso en producción.

Esta API admite paginación.

Permisos

El autor de la llamada debe tener un rol de visor o de área de trabajo superior.

Ámbitos delegados necesarios

Workspace.Read.All o Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identity	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interface

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
continuationToken	query		string	Token para recuperar la siguiente página de resultados.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	WorkspaceRelations	Solicitud completada correctamente.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: InsufficientPrivileges: el autor de la llamada no tiene suficientes permisos de área de trabajo. WorkspaceNotFound: no se encontró el área de trabajo especificada.

WorkspaceRelations

Solicitud completada correctamente.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

InsufficientPrivileges: el autor de la llamada no tiene suficientes permisos de área de trabajo.
WorkspaceNotFound: no se encontró el área de trabajo especificada.

Ejemplos

List workspace relations example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
    }
  ]
}

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
WorkspaceRelation	Objeto de relación del área de trabajo.
WorkspaceRelations	Lista de relaciones del área de trabajo.
WorkspaceRelationType	Tipo del área de trabajo relacionada en la relación. Se pueden agregar tipos de área de trabajo relacionados adicionales a lo largo del tiempo.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	ID de recurso que está involucrado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación comprensible para humanos del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación comprensible para humanos del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

WorkspaceRelation

Objeto

Objeto de relación del área de trabajo.

Nombre	Tipo	Description
id	string (uuid)	Identificador de relación del área de trabajo.
relatedWorkspaceId	string (uuid)	Identificador del área de trabajo relacionada.
relationType	WorkspaceRelationType	Tipo del área de trabajo relacionada en la relación.
workspaceId	string (uuid)	El identificador del área de trabajo.

WorkspaceRelations

Objeto

Lista de relaciones del área de trabajo.

Nombre	Tipo	Description
continuationToken	string	Token del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
continuationUri	string	Identificador URI del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
value	WorkspaceRelation[]	Lista de relaciones del área de trabajo.

WorkspaceRelationType

Enumeración

Tipo del área de trabajo relacionada en la relación. Se pueden agregar tipos de área de trabajo relacionados adicionales a lo largo del tiempo.

Valor	Description
Base	El área de trabajo relacionada es el área de trabajo base (origen).
Branch	El área de trabajo relacionada es un área de trabajo de rama.
RelatedWorkspace	El área de trabajo relacionada tiene una relación general.