Pull Requests - Create
Crie uma solicitação de pull.
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?api-version=7.1
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?supportsIterations={supportsIterations}&api-version=7.1
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
O nome da organização do Azure DevOps. |
|
repository
|
path | True |
string |
A ID do repositório do branch de destino da solicitação de pull. |
|
project
|
path |
string |
ID do projeto ou nome do projeto |
|
|
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api. |
|
supports
|
query |
boolean |
Se for true, os envios subsequentes para a solicitação de pull serão individualmente revisáveis. Defina isso como false para solicitações de pull grandes por motivos de desempenho se essa funcionalidade não for necessária. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| _links |
Links para outros objetos relacionados. |
|
| artifactId |
string |
Uma cadeia de caracteres que identifica exclusivamente essa solicitação de pull. Para gerar uma ID de artefato para uma solicitação de pull, use este modelo: |
| autoCompleteSetBy |
Se definido, a conclusão automática será habilitada para essa solicitação de pull e essa é a identidade que a habilitou. |
|
| closedBy |
O usuário que fechou a solicitação de pull. |
|
| closedDate |
string (date-time) |
A data em que a solicitação de pull foi fechada (concluída, abandonada ou mesclada externamente). |
| codeReviewId |
integer (int32) |
A ID de revisão de código da solicitação de pull. Usado internamente. |
| commits |
As confirmações contidas na solicitação de pull. |
|
| completionOptions |
Opções que afetam como a solicitação de pull será mesclada quando ela for concluída. |
|
| completionQueueTime |
string (date-time) |
A data mais recente em que a solicitação de pull inseriu a fila a ser concluída. Usado internamente. |
| createdBy |
A identidade do usuário que criou a solicitação de pull. |
|
| creationDate |
string (date-time) |
A data em que a solicitação de pull foi criada. |
| description |
string |
A descrição da solicitação de pull. |
| forkSource |
Se essa for uma PR de uma bifurcação, isso conterá informações sobre sua origem. |
|
| hasMultipleMergeBases |
boolean |
Aviso de várias bases de mesclagem |
| isDraft |
boolean |
Solicitação de pull de rascunho/WIP. |
| labels |
Os rótulos associados à solicitação de pull. |
|
| lastMergeCommit |
A confirmação da mesclagem de solicitação de pull mais recente. Se estiver vazia, a mesclagem mais recente está em andamento ou não teve êxito. |
|
| lastMergeSourceCommit |
A confirmação no cabeçalho do branch de origem no momento da última mesclagem de solicitação de pull. |
|
| lastMergeTargetCommit |
A confirmação no cabeçalho do branch de destino no momento da última mesclagem de solicitação de pull. |
|
| mergeFailureMessage |
string |
Se definido, a mesclagem de solicitação de pull falhou por esse motivo. |
| mergeFailureType |
O tipo de falha (se houver) da mesclagem da solicitação de pull. |
|
| mergeId |
string (uuid) |
A ID do trabalho usado para executar a mesclagem de solicitação de pull. Usado internamente. |
| mergeOptions |
Opções usadas quando a mesclagem de solicitação de pull é executada. Elas são separadas das opções de conclusão, pois a conclusão ocorre apenas uma vez e uma nova mesclagem será executada sempre que o branch de origem da solicitação de pull for alterado. |
|
| mergeStatus |
O status atual da mesclagem de solicitação de pull. |
|
| pullRequestId |
integer (int32) |
A ID da solicitação de pull. |
| remoteUrl |
string |
Usado internamente. |
| repository |
O repositório que contém o branch de destino da solicitação de pull. |
|
| reviewers |
Uma lista de revisores na solicitação de pull junto com o estado de seus votos. |
|
| sourceRefName |
string |
O nome do branch de origem da solicitação de pull. |
| status |
O status da solicitação de pull. |
|
| supportsIterations |
boolean |
Se for true, essa solicitação de pull oferecerá suporte a várias iterações. O suporte à iteração significa que os pushes individuais para o branch de origem da solicitação de pull podem ser revisados e os comentários deixados em uma iteração serão acompanhados em iterações futuras. |
| targetRefName |
string |
O nome do branch de destino da solicitação de pull. |
| title |
string |
O título da solicitação de pull. |
| url |
string |
Usado internamente. |
| workItemRefs |
Qualquer referência de item de trabalho associada a essa solicitação de pull. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
operação bem-sucedida |
Segurança
oauth2
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Escopos
| Nome | Description |
|---|---|
| vso.code_write | Concede a capacidade de ler, atualizar e excluir código-fonte, acessar metadados sobre confirmações, conjuntos de alterações, branches e outros artefatos de controle de versão. Também concede a capacidade de criar e gerenciar solicitações de pull e revisões de código e receber notificações sobre eventos de controle de versão por meio de ganchos de serviço. |
Exemplos
Solicitação de exemplo
POST https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests?api-version=7.1
{
"sourceRefName": "refs/heads/npaulk/my_work",
"targetRefName": "refs/heads/new_feature",
"title": "A new feature",
"description": "Adding a new feature",
"reviewers": [
{
"id": "d6245f20-2af8-44f4-9451-8107cb2767db"
}
]
}
Resposta de exemplo
{
"repository": {
"id": "3411ebc1-d5aa-464f-9615-0b527bc66719",
"name": "2016_10_31",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719",
"project": {
"id": "a7573007-bbb3-4341-b726-0c4148a07853",
"name": "2016_10_31",
"description": "test project created on Halloween 2016",
"url": "https://dev.azure.com/fabrikam/_apis/projects/a7573007-bbb3-4341-b726-0c4148a07853",
"state": "wellFormed",
"revision": 7
},
"remoteUrl": "https://dev.azure.com/fabrikam/_git/2016_10_31"
},
"pullRequestId": 22,
"codeReviewId": 22,
"status": "active",
"createdBy": {
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
},
"creationDate": "2016-11-01T16:30:31.6655471Z",
"title": "A new feature",
"description": "Adding a new feature",
"sourceRefName": "refs/heads/npaulk/my_work",
"targetRefName": "refs/heads/new_feature",
"mergeStatus": "queued",
"mergeId": "f5fc8381-3fb2-49fe-8a0d-27dcc2d6ef82",
"lastMergeSourceCommit": {
"commitId": "b60280bc6e62e2f880f1b63c1e24987664d3bda3",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/b60280bc6e62e2f880f1b63c1e24987664d3bda3"
},
"lastMergeTargetCommit": {
"commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"reviewers": [
{
"reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db",
"vote": 0,
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
}
],
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22"
},
"repository": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719"
},
"workItems": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/workitems"
},
"sourceBranch": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
},
"targetBranch": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
},
"sourceCommit": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/b60280bc6e62e2f880f1b63c1e24987664d3bda3"
},
"targetCommit": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"createdBy": {
"href": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
},
"iterations": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/iterations"
}
},
"supportsIterations": true,
"artifactId": "vstfs:///Git/PullRequestId/a7573007-bbb3-4341-b726-0c4148a07853%2f3411ebc1-d5aa-464f-9615-0b527bc66719%2f22"
}
Definições
| Nome | Description |
|---|---|
|
Change |
|
|
Git |
|
|
Git |
Fornece propriedades que descrevem uma confirmação do Git e metadados associados. |
|
Git |
Informações sobre um ref de bifurcação. |
|
Git |
Representa todos os dados associados a uma solicitação de pull. |
|
Git |
Preferências sobre como a solicitação de pull deve ser concluída. |
|
Git |
As opções que são usadas quando uma mesclagem de solicitação de pull é criada. |
|
Git |
Especifique a estratégia usada para mesclar a solicitação de pull durante a conclusão. Se MergeStrategy não estiver definido como nenhum valor, uma mesclagem no-FF será criada se SquashMerge == false. Se MergeStrategy não estiver definido como nenhum valor, as confirmações de solicitação de pull serão esmagadas se SquashMerge == true. A propriedade SquashMerge foi preterida. É recomendável definir explicitamente MergeStrategy em todos os casos. Se um valor explícito for fornecido para MergeStrategy, a propriedade SquashMerge será ignorada. |
|
Git |
|
|
Git |
|
|
Git |
|
|
Git |
Essa classe contém os metadados de um serviço/extensão postando um status. |
|
Git |
Contexto de status que identifica exclusivamente o status. |
|
Git |
Estado do status. |
|
Git |
|
|
Git |
Informações do usuário e data das operações do Git. |
|
Identity |
|
|
Identity |
Informações de identidade, incluindo uma votação em uma solicitação de pull. |
|
Item |
|
|
Item |
|
|
Project |
Estado do projeto. |
|
Project |
Visibilidade do projeto. |
|
Pull |
O status atual da mesclagem de solicitação de pull. |
|
Pull |
O tipo de falha (se houver) da mesclagem da solicitação de pull. |
|
Pull |
O status da solicitação de pull. |
|
Reference |
A classe para representar uma coleção de links de referência REST. |
|
Resource |
|
|
Team |
Objeto de referência para um TeamProjectCollection. |
|
Team |
Representa uma referência superficial a um TeamProject. |
|
Version |
O tipo de alteração feita no item. |
|
Web |
A representação de uma definição de marca que é enviada pelo fio. |
ChangeCountDictionary
GitChange
| Nome | Tipo | Description |
|---|---|---|
| changeId |
integer (int32) |
ID da alteração no grupo de alterações. |
| changeType |
O tipo de alteração feita no item. |
|
| item |
string (T) |
Versão atual. |
| newContent |
Conteúdo do item após a alteração. |
|
| newContentTemplate |
Novo modelo de conteúdo a ser usado ao enviar novas alterações por push. |
|
| originalPath |
string |
Caminho original do item, se diferente do caminho atual. |
| sourceServerItem |
string |
Caminho do item no servidor. |
| url |
string |
URL para recuperar o item. |
GitCommitRef
Fornece propriedades que descrevem uma confirmação do Git e metadados associados.
| Nome | Tipo | Description |
|---|---|---|
| _links |
Uma coleção de links de referência REST relacionados. |
|
| author |
Autor da confirmação. |
|
| changeCounts |
Contagens dos tipos de alterações (edições, exclusões etc.) incluídas na confirmação. |
|
| changes |
Uma enumeração das alterações incluídas na confirmação. |
|
| comment |
string |
Comentário ou mensagem da confirmação. |
| commentTruncated |
boolean |
Indica se o comentário é truncado da mensagem de comentário de confirmação completa do Git. |
| commitId |
string |
ID (SHA-1) da confirmação. |
| commitTooManyChanges |
boolean |
Indica que a confirmação contém muitas alterações a serem exibidas |
| committer |
Committer da confirmação. |
|
| parents |
string[] |
Uma enumeração das IDs de confirmação pai para essa confirmação. |
| push |
O push associado a essa confirmação. |
|
| remoteUrl |
string |
Caminho de URL remoto para a confirmação. |
| statuses |
Uma lista de metadados de status de serviços e extensões que podem associar informações adicionais à confirmação. |
|
| url |
string |
URL REST para esse recurso. |
| workItems |
Uma lista de workitems associados a essa confirmação. |
GitForkRef
Informações sobre um ref de bifurcação.
| Nome | Tipo | Description |
|---|---|---|
| _links |
A classe para representar uma coleção de links de referência REST. |
|
| creator | ||
| isLocked |
boolean |
|
| isLockedBy | ||
| name |
string |
|
| objectId |
string |
|
| peeledObjectId |
string |
|
| repository |
A ID do repositório da bifurcação. |
|
| statuses |
Essa classe contém os metadados de um serviço/extensão postando um status. |
|
| url |
string |
GitPullRequest
Representa todos os dados associados a uma solicitação de pull.
| Nome | Tipo | Description |
|---|---|---|
| _links |
Links para outros objetos relacionados. |
|
| artifactId |
string |
Uma cadeia de caracteres que identifica exclusivamente essa solicitação de pull. Para gerar uma ID de artefato para uma solicitação de pull, use este modelo: |
| autoCompleteSetBy |
Se definido, a conclusão automática será habilitada para essa solicitação de pull e essa é a identidade que a habilitou. |
|
| closedBy |
O usuário que fechou a solicitação de pull. |
|
| closedDate |
string (date-time) |
A data em que a solicitação de pull foi fechada (concluída, abandonada ou mesclada externamente). |
| codeReviewId |
integer (int32) |
A ID de revisão de código da solicitação de pull. Usado internamente. |
| commits |
As confirmações contidas na solicitação de pull. |
|
| completionOptions |
Opções que afetam como a solicitação de pull será mesclada quando ela for concluída. |
|
| completionQueueTime |
string (date-time) |
A data mais recente em que a solicitação de pull inseriu a fila a ser concluída. Usado internamente. |
| createdBy |
A identidade do usuário que criou a solicitação de pull. |
|
| creationDate |
string (date-time) |
A data em que a solicitação de pull foi criada. |
| description |
string |
A descrição da solicitação de pull. |
| forkSource |
Se essa for uma PR de uma bifurcação, isso conterá informações sobre sua origem. |
|
| hasMultipleMergeBases |
boolean |
Aviso de várias bases de mesclagem |
| isDraft |
boolean |
Solicitação de pull de rascunho/WIP. |
| labels |
Os rótulos associados à solicitação de pull. |
|
| lastMergeCommit |
A confirmação da mesclagem de solicitação de pull mais recente. Se estiver vazia, a mesclagem mais recente está em andamento ou não teve êxito. |
|
| lastMergeSourceCommit |
A confirmação no cabeçalho do branch de origem no momento da última mesclagem de solicitação de pull. |
|
| lastMergeTargetCommit |
A confirmação no cabeçalho do branch de destino no momento da última mesclagem de solicitação de pull. |
|
| mergeFailureMessage |
string |
Se definido, a mesclagem de solicitação de pull falhou por esse motivo. |
| mergeFailureType |
O tipo de falha (se houver) da mesclagem da solicitação de pull. |
|
| mergeId |
string (uuid) |
A ID do trabalho usado para executar a mesclagem de solicitação de pull. Usado internamente. |
| mergeOptions |
Opções usadas quando a mesclagem de solicitação de pull é executada. Elas são separadas das opções de conclusão, pois a conclusão ocorre apenas uma vez e uma nova mesclagem será executada sempre que o branch de origem da solicitação de pull for alterado. |
|
| mergeStatus |
O status atual da mesclagem de solicitação de pull. |
|
| pullRequestId |
integer (int32) |
A ID da solicitação de pull. |
| remoteUrl |
string |
Usado internamente. |
| repository |
O repositório que contém o branch de destino da solicitação de pull. |
|
| reviewers |
Uma lista de revisores na solicitação de pull junto com o estado de seus votos. |
|
| sourceRefName |
string |
O nome do branch de origem da solicitação de pull. |
| status |
O status da solicitação de pull. |
|
| supportsIterations |
boolean |
Se for true, essa solicitação de pull oferecerá suporte a várias iterações. O suporte à iteração significa que os pushes individuais para o branch de origem da solicitação de pull podem ser revisados e os comentários deixados em uma iteração serão acompanhados em iterações futuras. |
| targetRefName |
string |
O nome do branch de destino da solicitação de pull. |
| title |
string |
O título da solicitação de pull. |
| url |
string |
Usado internamente. |
| workItemRefs |
Qualquer referência de item de trabalho associada a essa solicitação de pull. |
GitPullRequestCompletionOptions
Preferências sobre como a solicitação de pull deve ser concluída.
| Nome | Tipo | Description |
|---|---|---|
| autoCompleteIgnoreConfigIds |
integer[] (int32) |
Lista de todas as IDs de configuração de política que não devem ser concluídas automaticamente. Aplica-se apenas a políticas opcionais (isBlocking == false). O preenchimento automático sempre aguarda as políticas necessárias (isBlocking == true). |
| bypassPolicy |
boolean |
Se for true, as políticas serão explicitamente ignoradas enquanto a solicitação de pull for concluída. |
| bypassReason |
string |
Se as políticas forem ignoradas, esse motivo será armazenado quanto ao motivo pelo qual o bypass foi usado. |
| deleteSourceBranch |
boolean |
Se for true, o branch de origem da solicitação de pull será excluído após a conclusão. |
| mergeCommitMessage |
string |
Se definido, isso será usado como a mensagem de confirmação da confirmação de mesclagem. |
| mergeStrategy |
Especifique a estratégia usada para mesclar a solicitação de pull durante a conclusão. Se MergeStrategy não estiver definido como nenhum valor, uma mesclagem no-FF será criada se SquashMerge == false. Se MergeStrategy não estiver definido como nenhum valor, as confirmações de solicitação de pull serão esmagadas se SquashMerge == true. A propriedade SquashMerge foi preterida. É recomendável definir explicitamente MergeStrategy em todos os casos. Se um valor explícito for fornecido para MergeStrategy, a propriedade SquashMerge será ignorada. |
|
| squashMerge |
boolean |
SquashMerge foi preterido. Você deve definir explicitamente o valor de MergeStrategy. Se MergeStrategy for definido como qualquer valor, o valor squashMerge será ignorado. Se MergeStrategy não estiver definido, a estratégia de mesclagem não será rápida se esse sinalizador for falso ou se for verdadeiro. |
| transitionWorkItems |
boolean |
Se for true, tentaremos fazer a transição de todos os itens de trabalho vinculados à solicitação de pull para o próximo estado lógico (ou seja, Ativo -> Resolvido) |
| triggeredByAutoComplete |
boolean |
Se for true, a tentativa de conclusão atual foi disparada por meio do preenchimento automático. Usado internamente. |
GitPullRequestMergeOptions
As opções que são usadas quando uma mesclagem de solicitação de pull é criada.
| Nome | Tipo | Description |
|---|---|---|
| conflictAuthorshipCommits |
boolean |
Se for true, as resoluções de conflito aplicadas durante a mesclagem serão colocadas em confirmações separadas para preservar as informações de autoria para a culpa do git, etc. |
| detectRenameFalsePositives |
boolean |
|
| disableRenames |
boolean |
Se for true, a detecção de renomeação não será executada durante a mesclagem. |
GitPullRequestMergeStrategy
Especifique a estratégia usada para mesclar a solicitação de pull durante a conclusão. Se MergeStrategy não estiver definido como nenhum valor, uma mesclagem no-FF será criada se SquashMerge == false. Se MergeStrategy não estiver definido como nenhum valor, as confirmações de solicitação de pull serão esmagadas se SquashMerge == true. A propriedade SquashMerge foi preterida. É recomendável definir explicitamente MergeStrategy em todos os casos. Se um valor explícito for fornecido para MergeStrategy, a propriedade SquashMerge será ignorada.
| Valor | Description |
|---|---|
| noFastForward |
Uma mesclagem de dois pais, sem avanço rápido. O branch de origem não foi alterado. Esse é o comportamento padrão. |
| rebase |
Basear novamente o branch de origem na parte superior da confirmação HEAD do branch de destino e encaminhar rapidamente o branch de destino. O branch de origem é atualizado durante a operação de rebase. |
| rebaseMerge |
Basear novamente o branch de origem na parte superior da confirmação HEAD do branch de destino e criar uma mesclagem sem avanço rápido de dois pais. O branch de origem é atualizado durante a operação de rebase. |
| squash |
Coloque todas as alterações da solicitação de pull em uma confirmação de pai único. |
GitPushRef
| Nome | Tipo | Description |
|---|---|---|
| _links |
A classe para representar uma coleção de links de referência REST. |
|
| date |
string (date-time) |
|
| pushId |
integer (int32) |
|
| pushedBy | ||
| url |
string |
GitRepository
| Nome | Tipo | Description |
|---|---|---|
| _links |
A classe para representar uma coleção de links de referência REST. |
|
| defaultBranch |
string |
|
| id |
string (uuid) |
|
| isDisabled |
boolean |
True se o repositório estiver desabilitado. False caso contrário. |
| isFork |
boolean |
True se o repositório foi criado como um fork. |
| isInMaintenance |
boolean |
True se o repositório estiver em manutenção. False caso contrário. |
| name |
string |
|
| parentRepository | ||
| project |
Representa uma referência superficial a um TeamProject. |
|
| remoteUrl |
string |
|
| size |
integer (int64) |
Tamanho compactado (bytes) do repositório. |
| sshUrl |
string |
|
| url |
string |
|
| validRemoteUrls |
string[] |
|
| webUrl |
string |
GitRepositoryRef
| Nome | Tipo | Description |
|---|---|---|
| collection |
Coleção de projetos de equipe em que este Fork reside |
|
| id |
string (uuid) |
|
| isFork |
boolean |
True se o repositório foi criado como um fork |
| name |
string |
|
| project |
Representa uma referência superficial a um TeamProject. |
|
| remoteUrl |
string |
|
| sshUrl |
string |
|
| url |
string |
GitStatus
Essa classe contém os metadados de um serviço/extensão postando um status.
| Nome | Tipo | Description |
|---|---|---|
| _links |
Links de referência. |
|
| context |
Contexto do status. |
|
| createdBy |
Identidade que criou o status. |
|
| creationDate |
string (date-time) |
Data e hora de criação do status. |
| description |
string |
Descrição do status. Normalmente descreve o estado atual do status. |
| id |
integer (int32) |
Identificador de status. |
| state |
Estado do status. |
|
| targetUrl |
string |
URL com detalhes de status. |
| updatedDate |
string (date-time) |
Data e hora da última atualização do status. |
GitStatusContext
Contexto de status que identifica exclusivamente o status.
| Nome | Tipo | Description |
|---|---|---|
| genre |
string |
Gênero do status. Normalmente, o nome do serviço/ferramenta que gera o status pode estar vazio. |
| name |
string |
O identificador de nome do status não pode ser nulo ou vazio. |
GitStatusState
Estado do status.
| Valor | Description |
|---|---|
| error |
Status com um erro. |
| failed |
Falha no status. |
| notApplicable |
O status não é aplicável ao objeto de destino. |
| notSet |
Estado de status não definido. Estado padrão. |
| pending |
Status pendente. |
| succeeded |
Status bem-sucedido. |
GitTemplate
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
Nome do modelo |
| type |
string |
Tipo do modelo |
GitUserDate
Informações do usuário e data das operações do Git.
| Nome | Tipo | Description |
|---|---|---|
| date |
string (date-time) |
Data da operação git. |
|
string |
Endereço de email do usuário que está executando a operação Git. |
|
| imageUrl |
string |
Url para o avatar do usuário. |
| name |
string |
Nome do usuário que está executando a operação Git. |
IdentityRef
| Nome | Tipo | Description |
|---|---|---|
| _links |
Este campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo. |
|
| descriptor |
string |
O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo em contas e organizações. |
| directoryAlias |
string |
Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef |
| displayName |
string |
Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem. |
| id |
string |
|
| imageUrl |
string |
Preterido – Disponível na entrada "avatar" do dicionário "_links" do IdentityRef |
| inactive |
boolean |
Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser |
| isAadIdentity |
boolean |
Preterido – pode ser adiado do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Preterido - não em uso na maioria das implementações pré-existentes de ToIdentityRef |
| uniqueName |
string |
Preterido – use Domain+PrincipalName em vez disso |
| url |
string |
Essa URL é a rota completa para o recurso de origem desta entidade de grafo. |
IdentityRefWithVote
Informações de identidade, incluindo uma votação em uma solicitação de pull.
| Nome | Tipo | Description |
|---|---|---|
| _links |
Este campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo. |
|
| descriptor |
string |
O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo em contas e organizações. |
| directoryAlias |
string |
Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef |
| displayName |
string |
Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem. |
| hasDeclined |
boolean |
Indica se esse revisor se recusou a examinar essa solicitação de pull. |
| id |
string |
|
| imageUrl |
string |
Preterido – Disponível na entrada "avatar" do dicionário "_links" do IdentityRef |
| inactive |
boolean |
Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser |
| isAadIdentity |
boolean |
Preterido – pode ser adiado do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| isFlagged |
boolean |
Indica se esse revisor está sinalizado para atenção nesta solicitação de pull. |
| isReapprove |
boolean |
Indica se essa votação de aprovação ainda deve ser tratada, mesmo que a votação não tenha sido alterada. |
| isRequired |
boolean |
Indica se esse é um revisor necessário para essa solicitação de pull. |
| profileUrl |
string |
Preterido - não em uso na maioria das implementações pré-existentes de ToIdentityRef |
| reviewerUrl |
string |
URL para recuperar informações sobre essa identidade |
| uniqueName |
string |
Preterido – use Domain+PrincipalName em vez disso |
| url |
string |
Essa URL é a rota completa para o recurso de origem desta entidade de grafo. |
| vote |
integer (int16) |
Vote em uma solicitação de pull: |
| votedFor |
Grupos ou equipes para os quais este revisor contribuiu. |
ItemContent
| Nome | Tipo | Description |
|---|---|---|
| content |
string |
|
| contentType |
ItemContentType
| Valor | Description |
|---|---|
| base64Encoded | |
| rawText |
ProjectState
Estado do projeto.
| Valor | Description |
|---|---|
| all |
Todos os projetos, independentemente do estado, exceto Excluídos. |
| createPending |
O projeto foi enfileirado para criação, mas o processo ainda não foi iniciado. |
| deleted |
O projeto foi excluído. |
| deleting |
O Project está em processo de exclusão. |
| new |
O Project está em processo de criação. |
| unchanged |
O projeto não foi alterado. |
| wellFormed |
O Project é completamente criado e pronto para uso. |
ProjectVisibility
Visibilidade do projeto.
| Valor | Description |
|---|---|
| private |
O projeto só é visível para usuários com acesso explícito. |
| public |
O projeto é visível para todos. |
PullRequestAsyncStatus
O status atual da mesclagem de solicitação de pull.
| Valor | Description |
|---|---|
| conflicts |
Falha na mesclagem de solicitação de pull devido a conflitos. |
| failure |
Falha na mesclagem de solicitação de pull. |
| notSet |
O status não está definido. Estado padrão. |
| queued |
A mesclagem de solicitação de pull está na fila. |
| rejectedByPolicy |
Mesclagem de solicitação de pull rejeitada pela política. |
| succeeded |
A mesclagem de solicitação de pull foi bem-sucedida. |
PullRequestMergeFailureType
O tipo de falha (se houver) da mesclagem da solicitação de pull.
| Valor | Description |
|---|---|
| caseSensitive |
Falha na mesclagem de solicitação de pull devido à incompatibilidade de maiúsculas e minúsculas. |
| none |
O tipo não está definido. Tipo padrão. |
| objectTooLarge |
Falha na mesclagem de solicitação de pull devido a um objeto ser muito grande. |
| unknown |
Tipo de falha de mesclagem de solicitação de pull desconhecido. |
PullRequestStatus
O status da solicitação de pull.
| Valor | Description |
|---|---|
| abandoned |
A solicitação de pull está abandonada. |
| active |
A solicitação de pull está ativa. |
| all |
Usado nos critérios de pesquisa de solicitação de pull para incluir todos os status. |
| completed |
A solicitação de pull foi concluída. |
| notSet |
Status não definido. Estado padrão. |
ReferenceLinks
A classe para representar uma coleção de links de referência REST.
| Nome | Tipo | Description |
|---|---|---|
| links |
object |
A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura. |
ResourceRef
| Nome | Tipo | Description |
|---|---|---|
| id |
string |
|
| url |
string |
TeamProjectCollectionReference
Objeto de referência para um TeamProjectCollection.
| Nome | Tipo | Description |
|---|---|---|
| avatarUrl |
string |
URL do avatar da coleção. |
| id |
string (uuid) |
ID da coleção. |
| name |
string |
Nome da coleção. |
| url |
string |
URL REST da coleção. |
TeamProjectReference
Representa uma referência superficial a um TeamProject.
| Nome | Tipo | Description |
|---|---|---|
| abbreviation |
string |
Abreviação do projeto. |
| defaultTeamImageUrl |
string |
Url para imagem de identidade de equipe padrão. |
| description |
string |
A descrição do projeto (se houver). |
| id |
string (uuid) |
Identificador de projeto. |
| lastUpdateTime |
string (date-time) |
Hora da última atualização do projeto. |
| name |
string |
Nome do projeto. |
| revision |
integer (int64) |
Revisão do projeto. |
| state |
Estado do projeto. |
|
| url |
string |
Url para a versão completa do objeto. |
| visibility |
Visibilidade do projeto. |
VersionControlChangeType
O tipo de alteração feita no item.
| Valor | Description |
|---|---|
| add | |
| all | |
| branch | |
| delete | |
| edit | |
| encoding | |
| lock | |
| merge | |
| none | |
| property | |
| rename | |
| rollback | |
| sourceRename | |
| targetRename | |
| undelete |
WebApiTagDefinition
A representação de uma definição de marca que é enviada pelo fio.
| Nome | Tipo | Description |
|---|---|---|
| active |
boolean |
Se a definição de marca está ativa ou não. |
| id |
string (uuid) |
ID da definição de marca. |
| name |
string |
O nome da definição da marca. |
| url |
string |
URL de recurso para a definição de marca. |