GitPullRequest.yml

### YamlMime:TSType
name: GitPullRequest
uid: azure-devops-extension-api.GitPullRequest
package: azure-devops-extension-api
summary: Represents all the data associated with a pull request.
fullName: GitPullRequest
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: artifactId
    uid: azure-devops-extension-api.GitPullRequest.artifactId
    package: azure-devops-extension-api
    summary: >-
      A string which uniquely identifies this pull request. To generate an
      artifact ID for a pull request, use this template:
      ```vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}```
    fullName: artifactId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'artifactId: string'
      return:
        description: ''
        type: string
  - name: autoCompleteSetBy
    uid: azure-devops-extension-api.GitPullRequest.autoCompleteSetBy
    package: azure-devops-extension-api
    summary: >-
      If set, auto-complete is enabled for this pull request and this is the
      identity that enabled it.
    fullName: autoCompleteSetBy
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'autoCompleteSetBy: IdentityRef'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.IdentityRef" />
  - name: closedBy
    uid: azure-devops-extension-api.GitPullRequest.closedBy
    package: azure-devops-extension-api
    summary: The user who closed the pull request.
    fullName: closedBy
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'closedBy: IdentityRef'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.IdentityRef" />
  - name: closedDate
    uid: azure-devops-extension-api.GitPullRequest.closedDate
    package: azure-devops-extension-api
    summary: >-
      The date when the pull request was closed (completed, abandoned, or merged
      externally).
    fullName: closedDate
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'closedDate: Date'
      return:
        description: ''
        type: Date
  - name: codeReviewId
    uid: azure-devops-extension-api.GitPullRequest.codeReviewId
    package: azure-devops-extension-api
    summary: The code review ID of the pull request. Used internally.
    fullName: codeReviewId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'codeReviewId: number'
      return:
        description: ''
        type: number
  - name: commits
    uid: azure-devops-extension-api.GitPullRequest.commits
    package: azure-devops-extension-api
    summary: The commits contained in the pull request.
    fullName: commits
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'commits: GitCommitRef[]'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.GitCommitRef" />[]
  - name: completionOptions
    uid: azure-devops-extension-api.GitPullRequest.completionOptions
    package: azure-devops-extension-api
    summary: >-
      Options which affect how the pull request will be merged when it is
      completed.
    fullName: completionOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'completionOptions: GitPullRequestCompletionOptions'
      return:
        description: ''
        type: >-
          <xref uid="azure-devops-extension-api.GitPullRequestCompletionOptions"
          />
  - name: completionQueueTime
    uid: azure-devops-extension-api.GitPullRequest.completionQueueTime
    package: azure-devops-extension-api
    summary: >-
      The most recent date at which the pull request entered the queue to be
      completed. Used internally.
    fullName: completionQueueTime
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'completionQueueTime: Date'
      return:
        description: ''
        type: Date
  - name: createdBy
    uid: azure-devops-extension-api.GitPullRequest.createdBy
    package: azure-devops-extension-api
    summary: The identity of the user who created the pull request.
    fullName: createdBy
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'createdBy: IdentityRef'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.IdentityRef" />
  - name: creationDate
    uid: azure-devops-extension-api.GitPullRequest.creationDate
    package: azure-devops-extension-api
    summary: The date when the pull request was created.
    fullName: creationDate
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'creationDate: Date'
      return:
        description: ''
        type: Date
  - name: description
    uid: azure-devops-extension-api.GitPullRequest.description
    package: azure-devops-extension-api
    summary: The description of the pull request.
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description: string'
      return:
        description: ''
        type: string
  - name: forkSource
    uid: azure-devops-extension-api.GitPullRequest.forkSource
    package: azure-devops-extension-api
    summary: >-
      If this is a PR from a fork this will contain information about its
      source.
    fullName: forkSource
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'forkSource: GitForkRef'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.GitForkRef" />
  - name: hasMultipleMergeBases
    uid: azure-devops-extension-api.GitPullRequest.hasMultipleMergeBases
    package: azure-devops-extension-api
    summary: Multiple mergebases warning
    fullName: hasMultipleMergeBases
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'hasMultipleMergeBases: boolean'
      return:
        description: ''
        type: boolean
  - name: isDraft
    uid: azure-devops-extension-api.GitPullRequest.isDraft
    package: azure-devops-extension-api
    summary: Draft / WIP pull request.
    fullName: isDraft
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isDraft: boolean'
      return:
        description: ''
        type: boolean
  - name: labels
    uid: azure-devops-extension-api.GitPullRequest.labels
    package: azure-devops-extension-api
    summary: The labels associated with the pull request.
    fullName: labels
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'labels: WebApiTagDefinition[]'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.WebApiTagDefinition" />[]
  - name: lastMergeCommit
    uid: azure-devops-extension-api.GitPullRequest.lastMergeCommit
    package: azure-devops-extension-api
    summary: >-
      The commit of the most recent pull request merge. If empty, the most
      recent merge is in progress or was unsuccessful.
    fullName: lastMergeCommit
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'lastMergeCommit: GitCommitRef'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.GitCommitRef" />
  - name: lastMergeSourceCommit
    uid: azure-devops-extension-api.GitPullRequest.lastMergeSourceCommit
    package: azure-devops-extension-api
    summary: >-
      The commit at the head of the source branch at the time of the last pull
      request merge.
    fullName: lastMergeSourceCommit
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'lastMergeSourceCommit: GitCommitRef'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.GitCommitRef" />
  - name: lastMergeTargetCommit
    uid: azure-devops-extension-api.GitPullRequest.lastMergeTargetCommit
    package: azure-devops-extension-api
    summary: >-
      The commit at the head of the target branch at the time of the last pull
      request merge.
    fullName: lastMergeTargetCommit
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'lastMergeTargetCommit: GitCommitRef'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.GitCommitRef" />
  - name: mergeFailureMessage
    uid: azure-devops-extension-api.GitPullRequest.mergeFailureMessage
    package: azure-devops-extension-api
    summary: If set, pull request merge failed for this reason.
    fullName: mergeFailureMessage
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'mergeFailureMessage: string'
      return:
        description: ''
        type: string
  - name: mergeFailureType
    uid: azure-devops-extension-api.GitPullRequest.mergeFailureType
    package: azure-devops-extension-api
    summary: The type of failure (if any) of the pull request merge.
    fullName: mergeFailureType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'mergeFailureType: PullRequestMergeFailureType'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.PullRequestMergeFailureType" />
  - name: mergeId
    uid: azure-devops-extension-api.GitPullRequest.mergeId
    package: azure-devops-extension-api
    summary: The ID of the job used to run the pull request merge. Used internally.
    fullName: mergeId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'mergeId: string'
      return:
        description: ''
        type: string
  - name: mergeOptions
    uid: azure-devops-extension-api.GitPullRequest.mergeOptions
    package: azure-devops-extension-api
    summary: >-
      Options used when the pull request merge runs. These are separate from
      completion options since completion happens only once and a new merge will
      run every time the source branch of the pull request changes.
    fullName: mergeOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'mergeOptions: GitPullRequestMergeOptions'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.GitPullRequestMergeOptions" />
  - name: mergeStatus
    uid: azure-devops-extension-api.GitPullRequest.mergeStatus
    package: azure-devops-extension-api
    summary: The current status of the pull request merge.
    fullName: mergeStatus
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'mergeStatus: PullRequestAsyncStatus'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.PullRequestAsyncStatus" />
  - name: pullRequestId
    uid: azure-devops-extension-api.GitPullRequest.pullRequestId
    package: azure-devops-extension-api
    summary: The ID of the pull request.
    fullName: pullRequestId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'pullRequestId: number'
      return:
        description: ''
        type: number
  - name: remoteUrl
    uid: azure-devops-extension-api.GitPullRequest.remoteUrl
    package: azure-devops-extension-api
    summary: Used internally.
    fullName: remoteUrl
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'remoteUrl: string'
      return:
        description: ''
        type: string
  - name: repository
    uid: azure-devops-extension-api.GitPullRequest.repository
    package: azure-devops-extension-api
    summary: The repository containing the target branch of the pull request.
    fullName: repository
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'repository: GitRepository'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.GitRepository" />
  - name: reviewers
    uid: azure-devops-extension-api.GitPullRequest.reviewers
    package: azure-devops-extension-api
    summary: >-
      A list of reviewers on the pull request along with the state of their
      votes.
    fullName: reviewers
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'reviewers: IdentityRefWithVote[]'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.IdentityRefWithVote" />[]
  - name: sourceRefName
    uid: azure-devops-extension-api.GitPullRequest.sourceRefName
    package: azure-devops-extension-api
    summary: The name of the source branch of the pull request.
    fullName: sourceRefName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'sourceRefName: string'
      return:
        description: ''
        type: string
  - name: status
    uid: azure-devops-extension-api.GitPullRequest.status
    package: azure-devops-extension-api
    summary: The status of the pull request.
    fullName: status
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'status: PullRequestStatus'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.PullRequestStatus" />
  - name: supportsIterations
    uid: azure-devops-extension-api.GitPullRequest.supportsIterations
    package: azure-devops-extension-api
    summary: >-
      If true, this pull request supports multiple iterations. Iteration support
      means individual pushes to the source branch of the pull request can be
      reviewed and comments left in one iteration will be tracked across future
      iterations.
    fullName: supportsIterations
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'supportsIterations: boolean'
      return:
        description: ''
        type: boolean
  - name: targetRefName
    uid: azure-devops-extension-api.GitPullRequest.targetRefName
    package: azure-devops-extension-api
    summary: The name of the target branch of the pull request.
    fullName: targetRefName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'targetRefName: string'
      return:
        description: ''
        type: string
  - name: title
    uid: azure-devops-extension-api.GitPullRequest.title
    package: azure-devops-extension-api
    summary: The title of the pull request.
    fullName: title
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'title: string'
      return:
        description: ''
        type: string
  - name: url
    uid: azure-devops-extension-api.GitPullRequest.url
    package: azure-devops-extension-api
    summary: Used internally.
    fullName: url
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'url: string'
      return:
        description: ''
        type: string
  - name: workItemRefs
    uid: azure-devops-extension-api.GitPullRequest.workItemRefs
    package: azure-devops-extension-api
    summary: Any work item references associated with this pull request.
    fullName: workItemRefs
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'workItemRefs: ResourceRef[]'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.ResourceRef" />[]