Interface GitPullRequestSearchCriteria

Pull requests can be searched for matching this criteria.

interface GitPullRequestSearchCriteria {
    creatorId?: string;
    includeLinks?: boolean;
    maxTime?: Date;
    minTime?: Date;
    queryTimeRangeType?: PullRequestTimeRangeType;
    repositoryId?: string;
    reviewerId?: string;
    sourceRefName?: string;
    sourceRepositoryId?: string;
    status?: PullRequestStatus;
    targetRefName?: string;
}

Properties

creatorId? includeLinks? maxTime? minTime? queryTimeRangeType? repositoryId? reviewerId? sourceRefName? sourceRepositoryId? status? targetRefName?

Properties

OptionalcreatorId

creatorId?: string

If set, search for pull requests that were created by this identity.

OptionalincludeLinks

includeLinks?: boolean

Whether to include the _links field on the shallow references

OptionalmaxTime

maxTime?: Date

If specified, filters pull requests that created/closed before this date based on the queryTimeRangeType specified.

OptionalminTime

minTime?: Date

If specified, filters pull requests that created/closed after this date based on the queryTimeRangeType specified.

OptionalqueryTimeRangeType

queryTimeRangeType?: PullRequestTimeRangeType

The type of time range which should be used for minTime and maxTime. Defaults to Created if unset.

OptionalrepositoryId

repositoryId?: string

If set, search for pull requests whose target branch is in this repository.

OptionalreviewerId

reviewerId?: string

If set, search for pull requests that have this identity as a reviewer.

OptionalsourceRefName

sourceRefName?: string

If set, search for pull requests from this branch.

OptionalsourceRepositoryId

sourceRepositoryId?: string

If set, search for pull requests whose source branch is in this repository.

Optionalstatus

status?: PullRequestStatus

If set, search for pull requests that are in this state. Defaults to Active if unset.

OptionaltargetRefName

targetRefName?: string

If set, search for pull requests into this branch.

Settings

Member Visibility

On This Page

Properties