Cmdlets for GitHub

Build 24.0.9060

ItemLinkedPullRequests

Lists information and values of the 'Linked pull requests' field for the project items.

View-Specific Information

Select

The cmdlet uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The cmdlet processes other filters client-side within the cmdlet.

  • ItemId supports the '=' comparison operator.
For example, the following query is processed server side:
SELECT * FROM [Project].[ItemLinkedPullRequests] WHERE [Project].[ItemLinkedPullRequests].[ItemId] = 'EXAMPLE'

Columns

Name Type References OrderBySupport Description
ItemId [KEY] String The ID of the item.
Id [KEY] String The ID of the pull request.
FullDatabaseId Long Identifies the primary key from the database as a BigInt.
Author String The actor's login name who authored the comment.
AuthorAssociation String Author's association with the subject of the comment.
Editor String The actor's login name who edited this pull request's body.
HeadRepositoryId String The repository associated with this pull request's head Ref.
HeadRepositoryOwner String The owner's login name of the repository associated with this pull request's head Ref.
MergedBy String The actor's login name who merged the pull request.
BaseRefId String Identifies the ID of the base ref associated with the pull request, even if the ref has been deleted.
BaseRefOid String Identifies the OID of the base ref associated with the pull request, even if the ref has been deleted.
BaseRefPrefix String Identifies the prefix of the base Ref associated with the pull request.
BaseRefName String Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
HeadRefId String Identifies the ID of the head ref associated with the pull request, even if the ref has been deleted.
HeadRefOid String Identifies the OID of the head ref associated with the pull request, even if the ref has been deleted.
HeadRefPrefix String Identifies the prefix of the head Ref associated with the pull request.
HeadRefName String Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
Title String Identifies the pull request title.
TitleHTML String Identifies the pull request title rendered to HTML.
Body String The body as Markdown.
BodyText String The body rendered to text.
BodyHTML String The body rendered to HTML.
State String Identifies the state of the pull request.
Number Int Identifies the pull request number.
Mergeable String Whether or not the pull request can be merged based on the existence of merge conflicts.
Merged Bool Whether or not the pull request was merged.
Closed Bool true if the pull request is closed.
ChangedFiles Int The number of changed files in this pull request.
Additions Int The number of additions in this pull request.
Deletions Int The number of deletions in this pull request.
TotalCommentsCount Int Returns a count of how many comments this pull request has received.
ReviewDecision String The current status of this pull request with respect to code review.
Locked Bool true if the pull request is locked.
ActiveLockReason String Reason that the conversation was locked.
IsDraft Bool Identifies if the pull request is a draft.
IsCrossRepository Bool The head and base repositories are different.
MaintainerCanModify Bool Indicates whether maintainers can modify the pull request.
CreatedViaEmail Bool Check if this comment was created via an email reply.
IncludesCreatedEdit Bool Check if this comment was edited and includes an edit with the creation data.
MergeCommitId String The commit ID that was created when this pull request was merged.
PotentialMergeCommitId String The commit ID that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See the mergeable field for more details on the mergeability of the pull request.
Permalink String The permalink to the pull request.
ResourcePath String The HTTP path for this pull request.
ChecksResourcePath String The HTTP path for the checks of this pull request.
RevertResourcePath String The HTTP path for reverting this pull request.
Url String The HTTP URL for this pull request.
ChecksUrl String The HTTP URL for the checks of this pull request.
RevertUrl String The HTTP URL for reverting this pull request.
LastEditedAt Datetime The moment the editor made the last edit.
MergedAt Datetime The date and time that the pull request was merged.
ClosedAt Datetime Identifies the date and time when the object was closed.
PublishedAt Datetime Identifies when the comment was published at.
UpdatedAt Datetime Identifies the date and time when the object was last updated.
CreatedAt Datetime Identifies the date and time when the object was created.
MilestoneId String Identifies the milestone's ID associated with the pull request.
MilestoneTitle String Identifies the title of the milestone.
MilestoneNumber Int Identifies the number of the milestone.
AutoMergeRequestCommitHeadline String The commit title of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.
AutoMergeRequestAuthorEmail String The email address of the author of this auto-merge request.
AutoMergeRequestCommitBody String The commit message of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.
AutoMergeRequestEnabledAt Datetime When was this auto-merge request was enabled.
AutoMergeRequestMergeMethod String The merge method of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.
ViewerDidAuthor Bool Did the viewer author this comment.
IsReadByViewer Bool Is this pull request read by the viewer.
ViewerSubscription String Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
ViewerCanClose Bool Indicates if the object can be closed by the viewer.
ViewerCanReact Bool Can user react to this subject.
ViewerCanReopen Bool Indicates if the object can be reopened by the viewer.
ViewerCanSubscribe Bool Check if the viewer is able to change their subscription status for the repository.
ViewerCanApplySuggestion Bool Whether or not the viewer can apply suggestion.
ViewerCanEditFiles Bool Can the viewer edit files within this pull request.
ViewerCanDeleteHeadRef Bool Check if the viewer can restore the deleted head ref.
ViewerCanDisableAutoMerge Bool Whether or not the viewer can disable auto-merge.
ViewerCanEnableAutoMerge Bool Whether or not the viewer can enable auto-merge.
ViewerCanMergeAsAdmin Bool Indicates whether the viewer can bypass branch protections and merge the pull request immediately.
ViewerCanUpdate Bool Check if the current viewer can update this object.
ViewerCanUpdateBranch Bool Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref. If the head ref is up to date or unable to be updated by this user, this will return false.
ViewerCannotUpdateReasons String Reasons why the current viewer can not update this comment.
ViewerLatestReviewRequestId String The ID of the viewer's latest review request.
ViewerLatestReviewId String The ID of the viewer's latest review.
IsMergeQueueEnabled Bool Indicates whether the pull request's base ref has a merge queue enabled.
IsInMergeQueue Bool Indicates whether the pull request is in a merge queue.
MergeQueueEntryId String The ID of this entry in the queue.
MergeQueueEntryJump Bool Whether this pull request should jump the queue.
MergeQueueEntryPosition Int The position of this entry in the queue.
MergeQueueEntrySolo Bool Does this pull request need to be deployed on its own.
MergeQueueEntryState String The state of this entry in the queue.
MergeQueueEntryEnqueuedAt Datetime The date and time this entry was added to the merge queue.
MergeQueueEntryEstimatedTimeToMerge Int The estimated time in seconds until this entry will be merged.
MergeQueueEntryBaseCommitId String The ID of the base commit in the queue entry.
MergeQueueEntryHeadCommitId String The ID of the head commit in the queue entry.
MergeQueueEntryMergeQueueId String The ID of the entry's queue.
MergeQueueEntryMergeQueueUrl String The HTTP URL for this merge queue.
MergeQueueEntryMergeQueueResourcePath String The HTTP path for this merge queue.
MergeQueueEntryMergeQueueNextEntryEstimatedTimeToMerge Int The estimated time in seconds until a newly added entry would be merged.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060