Pull Request Properties - Update

Referência

Serviço:: Git

Versão da API:: 7.1

Criar ou atualizar propriedades externas da solicitação de pull. A operação de patch pode ser add, replace ou remove. Para add operação, o caminho pode estar vazio. Se o caminho estiver vazio, o valor deverá ser uma lista de pares de valores de chave. Para replace operação, o caminho não pode estar vazio. Se o caminho não existir, a propriedade será adicionada à coleção. Para remove operação, o caminho não pode estar vazio. Se o caminho não existir, nenhuma ação será executada.

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/properties?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.
pullRequestId	path	True	integer (int32)	ID da solicitação de pull.
repositoryId	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.

Corpo da solicitação

Media Types: "application/json-patch+json"

Nome	Tipo	Description
from	string	O caminho a ser copiado para a operação Mover/Copiar.
op	Operation	A operação de patch
path	string	O caminho para a operação. No caso de uma matriz, um índice baseado em zero pode ser usado para especificar a posição na matriz (por exemplo, /biscuits/0/name). O caractere "-" pode ser usado em vez de um índice para inserir no final da matriz (por exemplo, /cookies/-).
value	object	O valor da operação. Isto é um primitivo ou um JToken.

Respostas

Nome	Tipo	Description
200 OK	PropertiesCollection	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

Add properties

Remove and replace properties

Add properties

Solicitação de exemplo

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/properties?api-version=7.1

[
  {
    "op": "add",
    "path": "/sampleId",
    "from": null,
    "value": 8
  },
  {
    "op": "add",
    "path": "/startedDateTime",
    "from": null,
    "value": "2017-09-25T15:26:49.4760511Z"
  },
  {
    "op": "add",
    "path": "",
    "from": null,
    "value": {
      "bytes": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n",
      "globalId": "2c2ca1ab-a062-4329-83bd-33b2843c7d6d"
    }
  }
]

Resposta de exemplo

Código de status:: 200

{
  "count": 6,
  "value": {
    "Microsoft.Git.PullRequest.SourceRefName": {
      "$type": "System.String",
      "$value": "refs/heads/vsts-api-sample/stage-range-cook"
    },
    "Microsoft.Git.PullRequest.TargetRefName": {
      "$type": "System.String",
      "$value": "refs/heads/master"
    },
    "sampleId": {
      "$type": "System.String",
      "$value": "8"
    },
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-25T15:26:49.477Z"
    },
    "bytes": {
      "$type": "System.String",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "globalId": {
      "$type": "System.String",
      "$value": "2c2ca1ab-a062-4329-83bd-33b2843c7d6d"
    }
  }
}

Remove and replace properties

Solicitação de exemplo

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/properties?api-version=7.1

[
  {
    "op": "replace",
    "path": "/sampleId",
    "from": null,
    "value": 12
  },
  {
    "op": "remove",
    "path": "/startedDateTime",
    "from": null,
    "value": null
  }
]

Resposta de exemplo

Código de status:: 200

{
  "count": 3,
  "value": {
    "Microsoft.Git.PullRequest.SourceRefName": {
      "$type": "System.String",
      "$value": "refs/heads/vsts-api-sample/letter-field-verse"
    },
    "Microsoft.Git.PullRequest.TargetRefName": {
      "$type": "System.String",
      "$value": "refs/heads/master"
    },
    "sampleId": {
      "$type": "System.String",
      "$value": "12"
    }
  }
}

Definições

Nome	Description
JsonPatchDocument	O modelo JSON para operações de patch JSON
Operation	A operação de patch
PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um `TypeCode != TypeCode.Object`), exceto `DBNull` são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma cadeia de caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.

JsonPatchDocument

Objeto

O modelo JSON para operações de patch JSON

Nome	Tipo	Description
from	string	O caminho a ser copiado para a operação Mover/Copiar.
op	Operation	A operação de patch
path	string	O caminho para a operação. No caso de uma matriz, um índice baseado em zero pode ser usado para especificar a posição na matriz (por exemplo, /biscuits/0/name). O caractere "-" pode ser usado em vez de um índice para inserir no final da matriz (por exemplo, /cookies/-).
value	object	O valor da operação. Isto é um primitivo ou um JToken.

Operation

Enumeração

A operação de patch

Valor	Description
add
copy
move
remove
replace
test

PropertiesCollection

Objeto

A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object), exceto DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma cadeia de caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.

Nome	Tipo	Description
count	integer (int32)	A contagem de propriedades na coleção.
item	object
keys	string[]	O conjunto de chaves na coleção.
values	string[]	O conjunto de valores na coleção.

Compartilhar via

Pull Request Properties - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

oauth2

Escopos

Exemplos

Add properties

Solicitação de exemplo

Resposta de exemplo

Remove and replace properties

Solicitação de exemplo

Resposta de exemplo

Definições

JsonPatchDocument

Operation

PropertiesCollection