GitPullRequestSearchCriteria interface
Pull requests can be searched for matching this criteria.
Properties
creator |
If set, search for pull requests that were created by this identity. |
include |
Whether to include the _links field on the shallow references |
max |
If specified, filters pull requests that created/closed before this date based on the queryTimeRangeType specified. |
min |
If specified, filters pull requests that created/closed after this date based on the queryTimeRangeType specified. |
query |
The type of time range which should be used for minTime and maxTime. Defaults to Created if unset. |
repository |
If set, search for pull requests whose target branch is in this repository. |
reviewer |
If set, search for pull requests that have this identity as a reviewer. |
source |
If set, search for pull requests from this branch. |
source |
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. |
target |
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
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
targetRefName
If set, search for pull requests into this branch.
targetRefName: string
Property Value
string