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 |
| labels | If set, filters pull requests that have labels matching the specified label names. |
| 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. |
| tags |
The operator used for filtering by labels. Defaults to And if unset. When And is used, pull requests must have all specified labels. When Or is used, pull requests must have at least one of the specified labels. |
| target |
If set, search for pull requests into this branch. |
| title | If set, filters pull requests that contain the specified text in the title. |
Property Details
creatorId
If set, search for pull requests that were created by this identity.
creatorId: stringProperty Value
string
includeLinks
Whether to include the _links field on the shallow references
includeLinks: booleanProperty Value
boolean
labels
If set, filters pull requests that have labels matching the specified label names.
labels: string[]Property Value
string[]
maxTime
If specified, filters pull requests that created/closed before this date based on the queryTimeRangeType specified.
maxTime: DateProperty Value
Date
minTime
If specified, filters pull requests that created/closed after this date based on the queryTimeRangeType specified.
minTime: DateProperty Value
Date
queryTimeRangeType
The type of time range which should be used for minTime and maxTime. Defaults to Created if unset.
queryTimeRangeType: PullRequestTimeRangeTypeProperty Value
repositoryId
If set, search for pull requests whose target branch is in this repository.
repositoryId: stringProperty Value
string
reviewerId
If set, search for pull requests that have this identity as a reviewer.
reviewerId: stringProperty Value
string
sourceRefName
If set, search for pull requests from this branch.
sourceRefName: stringProperty Value
string
sourceRepositoryId
If set, search for pull requests whose source branch is in this repository.
sourceRepositoryId: stringProperty Value
string
status
If set, search for pull requests that are in this state. Defaults to Active if unset.
status: PullRequestStatusProperty Value
tagsFilterOperator
The operator used for filtering by labels. Defaults to And if unset. When And is used, pull requests must have all specified labels. When Or is used, pull requests must have at least one of the specified labels.
tagsFilterOperator: TagsFilterOperatorProperty Value
targetRefName
If set, search for pull requests into this branch.
targetRefName: stringProperty Value
string
title
If set, filters pull requests that contain the specified text in the title.
title: stringProperty Value
string