Interface GitQueryCommitsCriteria

interface GitQueryCommitsCriteria {
    $skip?: number;
    $top?: number;
    author?: string;
    compareVersion?: GitVersionDescriptor;
    excludeDeletes?: boolean;
    fromCommitId?: string;
    fromDate?: string;
    historyMode?: GitHistoryMode;
    ids?: string[];
    includeLinks?: boolean;
    includePushData?: boolean;
    includeUserImageUrl?: boolean;
    includeWorkItems?: boolean;
    itemPath?: string;
    itemVersion?: GitVersionDescriptor;
    showOldestCommitsFirst?: boolean;
    toCommitId?: string;
    toDate?: string;
    user?: string;
}

Properties

$skip? $top? author? compareVersion? excludeDeletes? fromCommitId? fromDate? historyMode? ids? includeLinks? includePushData? includeUserImageUrl? includeWorkItems? itemPath? itemVersion? showOldestCommitsFirst? toCommitId? toDate? user?

Properties

Optional$skip

$skip?: number

Number of entries to skip

Optional$top

$top?: number

Maximum number of entries to retrieve

Optionalauthor

author?: string

Alias or display name of the author

OptionalcompareVersion

compareVersion?: GitVersionDescriptor

Only applicable when ItemVersion specified. If provided, start walking history starting at this commit.

OptionalexcludeDeletes

excludeDeletes?: boolean

Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.

OptionalfromCommitId

fromCommitId?: string

If provided, a lower bound for filtering commits alphabetically

OptionalfromDate

fromDate?: string

If provided, only include history entries created after this date (string)

OptionalhistoryMode

historyMode?: GitHistoryMode

What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.

Optionalids

ids?: string[]

If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.

OptionalincludeLinks

includeLinks?: boolean

Whether to include the _links field on the shallow references

OptionalincludePushData

includePushData?: boolean

Whether to include the push information

OptionalincludeUserImageUrl

includeUserImageUrl?: boolean

Whether to include the image Url for committers and authors

OptionalincludeWorkItems

includeWorkItems?: boolean

Whether to include linked work items

OptionalitemPath

itemPath?: string

Path of item to search under

OptionalitemVersion

itemVersion?: GitVersionDescriptor

If provided, identifies the commit or branch to search

OptionalshowOldestCommitsFirst

showOldestCommitsFirst?: boolean

If enabled, this option will ignore the itemVersion and compareVersion parameters

OptionaltoCommitId

toCommitId?: string

If provided, an upper bound for filtering commits alphabetically

OptionaltoDate

toDate?: string

If provided, only include history entries created before this date (string)

Optionaluser

user?: string

Alias or display name of the committer

Settings

Member Visibility

On This Page

Properties