GitPullRequestSearchCriteria interface

Package:

azure-devops-extension-api

Pull requests can be searched for matching this criteria.

Properties

creatorId	If set, search for pull requests that were created by this identity.
includeLinks	Whether to include the _links field on the shallow references
maxTime	If specified, filters pull requests that created/closed before this date based on the queryTimeRangeType specified.
minTime	If specified, filters pull requests that created/closed after this date based on the queryTimeRangeType specified.
queryTimeRangeType	The type of time range which should be used for minTime and maxTime. Defaults to Created if unset.
repositoryId	If set, search for pull requests whose target branch is in this repository.
reviewerId	If set, search for pull requests that have this identity as a reviewer.
sourceRefName	If set, search for pull requests from this branch.
sourceRepositoryId	If set, search for pull requests whose source branch is in this repository.
status	If set, search for pull requests that are in this state. Defaults to Active if unset.
targetRefName	If set, search for pull requests into this branch.

Property Details

creatorId

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

creatorId: string

Property Value

string

includeLinks

Whether to include the _links field on the shallow references

includeLinks: boolean

Property Value

boolean

maxTime

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

maxTime: Date

Property Value

Date

minTime

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

minTime: Date

Property Value

Date

queryTimeRangeType

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

queryTimeRangeType: PullRequestTimeRangeType

Property Value

PullRequestTimeRangeType

repositoryId

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

repositoryId: string

Property Value

string

reviewerId

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

reviewerId: string

Property Value

string

sourceRefName

If set, search for pull requests from this branch.

sourceRefName: string

Property Value

string

sourceRepositoryId

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

sourceRepositoryId: string

Property Value

string

status

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

status: PullRequestStatus

Property Value

PullRequestStatus

targetRefName

If set, search for pull requests into this branch.

targetRefName: string

Property Value

string