Pull Request Properties - List

Service:: Git

API Version:: 7.1

Get external properties of the pull request.

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

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
pullRequestId	path	True	integer (int32)	ID of the pull request.
repositoryId	path	True	string	The repository ID of the pull request’s target branch.
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	PropertiesCollection	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: 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

Scopes

Name	Description
vso.code	Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Examples

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "count": 4,
  "value": {
    "Microsoft.Git.PullRequest.SourceRefName": {
      "$type": "System.String",
      "$value": "refs/heads/vsts-api-sample/taste-page-level"
    },
    "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:43.667Z"
    }
  }
}

Definitions

PropertiesCollection

Object

The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a TypeCode != TypeCode.Object) except for DBNull are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.

Name	Type	Description
count	integer (int32)	The count of properties in the collection.
item	object
keys	string[]	The set of keys in the collection.
values	string[]	The set of values in the collection.

Share via