Interface PullRequest

Corresponds to a VCS Pull Request attached to a Shortcut story.

interface PullRequest {
    branch_id: number;
    branch_name: string;
    build_status?: string;
    closed: boolean;
    created_at: string;
    draft: boolean;
    entity_type: string;
    has_overlapping_stories: boolean;
    id: number;
    merged: boolean;
    num_added: number;
    num_commits?: number;
    num_modified?: number;
    num_removed: number;
    number: number;
    overlapping_stories?: number[];
    repository_id: number;
    review_status?: string;
    target_branch_id: number;
    target_branch_name: string;
    title: string;
    updated_at: string;
    url: string;
    vcs_labels?: PullRequestLabel[];
}

Properties

branch_id branch_name build_status? closed created_at draft entity_type has_overlapping_stories id merged num_added num_commits? num_modified? num_removed number overlapping_stories? repository_id review_status? target_branch_id target_branch_name title updated_at url vcs_labels?

Properties

branch_id

branch_id: number

The ID of the branch for the particular pull request.

Format

int64

branch_name

branch_name: string

The name of the branch for the particular pull request.

Optionalbuild_status

build_status?: string

The status of the Continuous Integration workflow for the pull request.

closed

closed: boolean

True/False boolean indicating whether the VCS pull request has been closed.

created_at

created_at: string

The time/date the pull request was created.

Format

date-time

draft

draft: boolean

True/False boolean indicating whether the VCS pull request is in the draft state.

entity_type

entity_type: string

A string description of this resource.

has_overlapping_stories

has_overlapping_stories: boolean

Boolean indicating that the Pull Request has Stories that have Pull Requests that change at least one of the same lines this Pull Request changes.

id

id: number

The unique ID associated with the pull request in Shortcut.

Format

int64

merged

merged: boolean

True/False boolean indicating whether the VCS pull request has been merged.

num_added

num_added: number

Number of lines added in the pull request, according to VCS.

Format

int64

Optionalnum_commits

num_commits?: number

The number of commits on the pull request.

Format

int64

Optionalnum_modified

num_modified?: number

Number of lines modified in the pull request, according to VCS.

Format

int64

num_removed

num_removed: number

Number of lines removed in the pull request, according to VCS.

Format

int64

number

number: number

The pull request's unique number ID in VCS.

Format

int64

Optionaloverlapping_stories

overlapping_stories?: number[]

An array of Story ids that have Pull Requests that change at least one of the same lines this Pull Request changes.

repository_id

repository_id: number

The ID of the repository for the particular pull request.

Format

int64

Optionalreview_status

review_status?: string

The status of the review for the pull request.

target_branch_id

target_branch_id: number

The ID of the target branch for the particular pull request.

Format

int64

target_branch_name

target_branch_name: string

The name of the target branch for the particular pull request.

title

title: string

The title of the pull request.

updated_at

updated_at: string

The time/date the pull request was created.

Format

date-time

url

url: string

The URL for the pull request.

Optionalvcs_labels

vcs_labels?: PullRequestLabel[]

An array of PullRequestLabels attached to the PullRequest.

Settings

Member Visibility

On This Page

Properties