Interface GitPullRequest

Represents all the data associated with a pull request.

interface GitPullRequest {
    _links?: any;
    artifactId?: string;
    autoCompleteSetBy?: IdentityRef;
    closedBy?: IdentityRef;
    closedDate?: Date;
    codeReviewId?: number;
    commits?: GitCommitRef[];
    completionOptions?: GitPullRequestCompletionOptions;
    completionQueueTime?: Date;
    createdBy?: IdentityRef;
    creationDate?: Date;
    description?: string;
    forkSource?: GitForkRef;
    hasMultipleMergeBases?: boolean;
    isDraft?: boolean;
    labels?: WebApiTagDefinition[];
    lastMergeCommit?: GitCommitRef;
    lastMergeSourceCommit?: GitCommitRef;
    lastMergeTargetCommit?: GitCommitRef;
    mergeFailureMessage?: string;
    mergeFailureType?: PullRequestMergeFailureType;
    mergeId?: string;
    mergeOptions?: GitPullRequestMergeOptions;
    mergeStatus?: PullRequestAsyncStatus;
    pullRequestId?: number;
    remoteUrl?: string;
    repository?: GitRepository;
    reviewers?: IdentityRefWithVote[];
    sourceRefName?: string;
    status?: PullRequestStatus;
    supportsIterations?: boolean;
    targetRefName?: string;
    title?: string;
    url?: string;
    workItemRefs?: ResourceRef[];
}

Properties

_links? artifactId? autoCompleteSetBy? closedBy? closedDate? codeReviewId? commits? completionOptions? completionQueueTime? createdBy? creationDate? description? forkSource? hasMultipleMergeBases? isDraft? labels? lastMergeCommit? lastMergeSourceCommit? lastMergeTargetCommit? mergeFailureMessage? mergeFailureType? mergeId? mergeOptions? mergeStatus? pullRequestId? remoteUrl? repository? reviewers? sourceRefName? status? supportsIterations? targetRefName? title? url? workItemRefs?

Properties

Optional_links

_links?: any

Links to other related objects.

OptionalartifactId

artifactId?: string

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}

OptionalautoCompleteSetBy

autoCompleteSetBy?: IdentityRef

If set, auto-complete is enabled for this pull request and this is the identity that enabled it.

OptionalclosedBy

closedBy?: IdentityRef

The user who closed the pull request.

OptionalclosedDate

closedDate?: Date

The date when the pull request was closed (completed, abandoned, or merged externally).

OptionalcodeReviewId

codeReviewId?: number

The code review ID of the pull request. Used internally.

Optionalcommits

commits?: GitCommitRef[]

The commits contained in the pull request.

OptionalcompletionOptions

completionOptions?: GitPullRequestCompletionOptions

Options which affect how the pull request will be merged when it is completed.

OptionalcompletionQueueTime

completionQueueTime?: Date

The most recent date at which the pull request entered the queue to be completed. Used internally.

OptionalcreatedBy

createdBy?: IdentityRef

The identity of the user who created the pull request.

OptionalcreationDate

creationDate?: Date

The date when the pull request was created.

Optionaldescription

description?: string

The description of the pull request.

OptionalforkSource

forkSource?: GitForkRef

If this is a PR from a fork this will contain information about its source.

OptionalhasMultipleMergeBases

hasMultipleMergeBases?: boolean

Multiple mergebases warning

OptionalisDraft

isDraft?: boolean

Draft / WIP pull request.

Optionallabels

labels?: WebApiTagDefinition[]

The labels associated with the pull request.

OptionallastMergeCommit

lastMergeCommit?: GitCommitRef

The commit of the most recent pull request merge. If empty, the most recent merge is in progress or was unsuccessful.

OptionallastMergeSourceCommit

lastMergeSourceCommit?: GitCommitRef

The commit at the head of the source branch at the time of the last pull request merge.

OptionallastMergeTargetCommit

lastMergeTargetCommit?: GitCommitRef

The commit at the head of the target branch at the time of the last pull request merge.

OptionalmergeFailureMessage

mergeFailureMessage?: string

If set, pull request merge failed for this reason.

OptionalmergeFailureType

mergeFailureType?: PullRequestMergeFailureType

The type of failure (if any) of the pull request merge.

OptionalmergeId

mergeId?: string

The ID of the job used to run the pull request merge. Used internally.

OptionalmergeOptions

mergeOptions?: GitPullRequestMergeOptions

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.

OptionalmergeStatus

mergeStatus?: PullRequestAsyncStatus

The current status of the pull request merge.

OptionalpullRequestId

pullRequestId?: number

The ID of the pull request.

OptionalremoteUrl

remoteUrl?: string

Used internally.

Optionalrepository

repository?: GitRepository

The repository containing the target branch of the pull request.

Optionalreviewers

reviewers?: IdentityRefWithVote[]

A list of reviewers on the pull request along with the state of their votes.

OptionalsourceRefName

sourceRefName?: string

The name of the source branch of the pull request.

Optionalstatus

status?: PullRequestStatus

The status of the pull request.

OptionalsupportsIterations

supportsIterations?: boolean

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.

OptionaltargetRefName

targetRefName?: string

The name of the target branch of the pull request.

Optionaltitle

title?: string

The title of the pull request.

Optionalurl

url?: string

Used internally.

OptionalworkItemRefs

workItemRefs?: ResourceRef[]

Any work item references associated with this pull request.

Settings

Member Visibility

On This Page

Properties