Git - Create Workspace Relation

Servicio:
Core
Versión de la API:
v1

Crea una relación de área de trabajo entre el área de trabajo especificada y una área de trabajo relacionada.

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.

Crea una relación de bifurcación entre un área de trabajo de rama y su área de trabajo base.

Permisos

El autor de la llamada debe tener un rol de administrador en el área de trabajo de la rama y un rol colaborador o superior en el área de trabajo base.

Ámbitos delegados necesarios

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

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

El identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
relatedWorkspaceId True

string (uuid)

Identificador del área de trabajo relacionada.
relationType True

WorkspaceRelationType

Tipo del área de trabajo relacionada que se va a crear en la relación. Solo Base y Branch son válidos para la creación.

Respuestas

Nombre Tipo Description
201 Created

WorkspaceRelation

Se ha creado 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.

  • WorkspaceRelationAlreadyExists: ya existe una relación entre las áreas de trabajo especificadas.

  • WorkspaceRelationBidirectionalExists: ya existe una relación entre estas áreas de trabajo en la dirección opuesta.

  • WorkspaceRelationInvalidArgument: argumentos no válidos proporcionados para la operación de relación del área de trabajo.

  • WorkspaceRelationInvalidType: tipo de relación de área de trabajo no válida.

  • WorkspaceRelationSelfReferencing: un área de trabajo no puede estar relacionada con sí misma.

  • WorkspaceRelationBaseIsBranch: el área de trabajo base ya es una rama de otra área de trabajo.

  • WorkspaceRelationTargetHasBranches: el área de trabajo de destino ya tiene áreas de trabajo de rama.

  • WorkspaceRelationDifferentBase: el área de trabajo de destino tiene un área de trabajo base diferente.

  • WorkspaceRelationRootDirectoryMismatch: las áreas de trabajo no están conectadas a la misma raíz del repositorio de Git.

Ejemplos

Create a workspace relation example

Solicitud de ejemplo

POST https://api.fabric.microsoft.com/v1/workspaces/55555555-5555-5555-5555-555555555555/git/workspaceRelations

{
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

Respuesta de muestra

status code:
201 
{
  "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "workspaceId": "55555555-5555-5555-5555-555555555555",
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

Definiciones

Nombre Description
CreateWorkspaceRelationRequest

Carga de solicitud para crear una relación de área de trabajo.
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.
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.

CreateWorkspaceRelationRequest

Objeto

Carga de solicitud para crear una relación de área de trabajo.

Nombre Tipo Description
relatedWorkspaceId

string (uuid)

Identificador del área de trabajo relacionada.
relationType

WorkspaceRelationType

Tipo del área de trabajo relacionada que se va a crear en la relación. Solo Base y Branch son válidos para la creación.

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.

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.