Class GitApi

Hierarchy (View Summary)

ClientApiBase
- GitApi

Implements

IGitApi

Index

Constructors

constructor

new GitApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): GitApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns GitApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/GitApi.ts:172

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

`Static` `Readonly`RESOURCE_AREA_ID

RESOURCE_AREA_ID: "4e080c62-fa21-4fbc-8fef-2a10a2b38049"

Methods

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of IGitApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createAnnotatedTag

createAnnotatedTag(
    tagObject: GitAnnotatedTag,
    project: string,
    repositoryId: string,
): Promise<GitAnnotatedTag>
Create an annotated tag.
Parameters
- tagObject: GitAnnotatedTag
  Object containing details of tag to be created.
- project: string
  Project ID or project name
- repositoryId: string
  ID or name of the repository.
Returns Promise<GitAnnotatedTag>
Implementation of IGitApi.createAnnotatedTag
- Defined in repos/azure-devops-node-api/api/GitApi.ts:697

createAttachment

createAttachment(
    customHeaders: any,
    contentStream: ReadableStream,
    fileName: string,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<Attachment>
Attach a new file to a pull request.
Parameters
- customHeaders: any
- contentStream: ReadableStream
  Content to upload
- fileName: string
  The name of the file.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<Attachment>
Implementation of IGitApi.createAttachment
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3128

createCherryPick

createCherryPick(
    cherryPickToCreate: GitAsyncRefOperationParameters,
    project: string,
    repositoryId: string,
): Promise<GitCherryPick>
Cherry pick a specific commit or commits that are associated to a pull request into a new branch.
Parameters
- cherryPickToCreate: GitAsyncRefOperationParameters
- project: string
  Project ID or project name
- repositoryId: string
  ID of the repository.
Returns Promise<GitCherryPick>
Implementation of IGitApi.createCherryPick
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1589

createComment

createComment(
    comment: Comment,
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    project?: string,
): Promise<Comment>
Create a comment on a specific thread in a pull request (up to 500 comments can be created per thread).
Parameters
- comment: Comment
  The comment to create. Comments can be up to 150,000 characters.
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  ID of the thread that the desired comment is in.
- Optionalproject: string
  Project ID or project name
Returns Promise<Comment>
Implementation of IGitApi.createComment
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5684

createCommitStatus

createCommitStatus(
    gitCommitStatusToCreate: GitStatus,
    commitId: string,
    repositoryId: string,
    project?: string,
): Promise<GitStatus>
Create Git commit status.
Parameters
- gitCommitStatusToCreate: GitStatus
  Git commit status object to create.
- commitId: string
  ID of the Git commit.
- repositoryId: string
  ID of the repository.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitStatus>
Implementation of IGitApi.createCommitStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7567

createFavorite

createFavorite(
favorite: GitRefFavorite,
project: string,
): Promise<GitRefFavorite>
Creates a ref favorite
Parameters
- favorite: GitRefFavorite
  The ref favorite to create.
- project: string
  Project ID or project name
Returns Promise<GitRefFavorite>
Implementation of IGitApi.createFavorite
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6681

createForkSyncRequest

createForkSyncRequest(
    syncParams: GitForkSyncRequestParameters,
    repositoryNameOrId: string,
    project?: string,
    includeLinks?: boolean,
): Promise<GitForkSyncRequest>
Request that another repository's refs be fetched into this one. It syncs two existing forks. To create a fork, please see the repositories endpoint
Parameters
- syncParams: GitForkSyncRequestParameters
  Source repository and ref mapping.
- repositoryNameOrId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- OptionalincludeLinks: boolean
  True to include links
Returns Promise<GitForkSyncRequest>
Implementation of IGitApi.createForkSyncRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2185

createImportRequest

createImportRequest(
    importRequest: GitImportRequest,
    project: string,
    repositoryId: string,
): Promise<GitImportRequest>
Create an import request.
Parameters
- importRequest: GitImportRequest
  The import request to create.
- project: string
  Project ID or project name
- repositoryId: string
  The name or ID of the repository.
Returns Promise<GitImportRequest>
Implementation of IGitApi.createImportRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2345

createLike

createLike(
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    commentId: number,
    project?: string,
): Promise<void>
Add a like on a comment.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  The ID of the thread that contains the comment.
- commentId: number
  The ID of the comment.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.createLike
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3366

createMergeRequest

createMergeRequest(
    mergeParameters: GitMergeParameters,
    project: string,
    repositoryNameOrId: string,
    includeLinks?: boolean,
): Promise<GitMerge>
Request a git merge operation. Currently we support merging only 2 commits.
Parameters
- mergeParameters: GitMergeParameters
  Parents commitIds and merge commit messsage.
- project: string
  Project ID or project name
- repositoryNameOrId: string
  The name or ID of the repository.
- OptionalincludeLinks: boolean
  True to include links
Returns Promise<GitMerge>
Implementation of IGitApi.createMergeRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3020

createPullRequest

createPullRequest(
    gitPullRequestToCreate: GitPullRequest,
    repositoryId: string,
    project?: string,
    supportsIterations?: boolean,
): Promise<GitPullRequest>
Create a pull request.
Parameters
- gitPullRequestToCreate: GitPullRequest
  The pull request to create.
- repositoryId: string
  The repository ID of the pull request's target branch.
- Optionalproject: string
  Project ID or project name
- OptionalsupportsIterations: boolean
  If true, subsequent pushes to the pull request will be individually reviewable. Set this to false for large pull requests for performance reasons if this functionality is not needed.
Returns Promise<GitPullRequest>
Implementation of IGitApi.createPullRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5153

createPullRequestIterationStatus

createPullRequestIterationStatus(
    status: GitPullRequestStatus,
    repositoryId: string,
    pullRequestId: number,
    iterationId: number,
    project?: string,
): Promise<GitPullRequestStatus>
Create a pull request status on the iteration. This operation will have the same result as Create status on pull request with specified iteration ID in the request body.
Parameters
- status: GitPullRequestStatus
  Pull request status to create.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- iterationId: number
  ID of the pull request iteration.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestStatus>
Implementation of IGitApi.createPullRequestIterationStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4016

createPullRequestLabel

createPullRequestLabel(
    label: WebApiCreateTagRequestData,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
    projectId?: string,
): Promise<WebApiTagDefinition>
Create a tag (if that does not exists yet) and add that as a label (tag) for a specified pull request. The only required field is the name of the new label (tag).
Parameters
- label: WebApiCreateTagRequestData
  Label to assign to the pull request.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
- OptionalprojectId: string
  Project ID or project name.
Returns Promise<WebApiTagDefinition>
Implementation of IGitApi.createPullRequestLabel
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4281

createPullRequestReviewer

createPullRequestReviewer(
    reviewer: IdentityRefWithVote,
    repositoryId: string,
    pullRequestId: number,
    reviewerId: string,
    project?: string,
): Promise<IdentityRefWithVote>
Add a reviewer to a pull request or cast a vote.
Parameters
- reviewer: IdentityRefWithVote
  Reviewer's vote.
  If the reviewer's ID is included here, it must match the reviewerID parameter.
  Reviewers can set their own vote with this method. When adding other reviewers, vote must be set to zero.
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- reviewerId: string
  ID of the reviewer.
- Optionalproject: string
  Project ID or project name
Returns Promise<IdentityRefWithVote>
Implementation of IGitApi.createPullRequestReviewer
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4652

createPullRequestReviewers

createPullRequestReviewers(
    reviewers: IdentityRef[],
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<IdentityRefWithVote[]>
Add reviewers to a pull request.
Parameters
- reviewers: IdentityRef[]
  Reviewers to add to the pull request.
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<IdentityRefWithVote[]>
Implementation of IGitApi.createPullRequestReviewers
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4703

createPullRequestStatus

createPullRequestStatus(
    status: GitPullRequestStatus,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<GitPullRequestStatus>
Create a pull request status.
Parameters
- status: GitPullRequestStatus
  Pull request status to create.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestStatus>
Implementation of IGitApi.createPullRequestStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5433

createPush

createPush(
    push: GitPush,
    repositoryId: string,
    project?: string,
): Promise<GitPush>
Push changes to the repository.
Parameters
- push: GitPush
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPush>
Implementation of IGitApi.createPush
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6210

createRepository

createRepository(
    gitRepositoryToCreate: GitRepositoryCreateOptions,
    project?: string,
    sourceRef?: string,
): Promise<GitRepository>
Create a git repository in a team project.
Parameters
- gitRepositoryToCreate: GitRepositoryCreateOptions
  Specify the repo name, team project and/or parent repository. Team project information can be omitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).
- Optionalproject: string
  Project ID or project name
- OptionalsourceRef: string
  [optional] Specify the source refs to use while creating a fork repo
Returns Promise<GitRepository>
Implementation of IGitApi.createRepository
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6910

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of IGitApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

createRevert

createRevert(
    revertToCreate: GitAsyncRefOperationParameters,
    project: string,
    repositoryId: string,
): Promise<GitRevert>
Starts the operation to create a new branch which reverts changes introduced by either a specific commit or commits that are associated to a pull request.
Parameters
- revertToCreate: GitAsyncRefOperationParameters
- project: string
  Project ID or project name
- repositoryId: string
  ID of the repository.
Returns Promise<GitRevert>
Implementation of IGitApi.createRevert
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7419

createThread

createThread(
    commentThread: GitPullRequestCommentThread,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<GitPullRequestCommentThread>
Create a thread in a pull request.
Parameters
- commentThread: GitPullRequestCommentThread
  The thread to create. Thread must contain at least one comment.
- repositoryId: string
  Repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestCommentThread>
Implementation of IGitApi.createThread
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5946

createUnmaterializedPullRequestReviewer

createUnmaterializedPullRequestReviewer(
    reviewer: IdentityRefWithVote,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<IdentityRefWithVote>
Add an unmaterialized identity to the reviewers of a pull request.
Parameters
- reviewer: IdentityRefWithVote
  Reviewer to add to the pull request.
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<IdentityRefWithVote>
Implementation of IGitApi.createUnmaterializedPullRequestReviewer
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4752

deleteAttachment

deleteAttachment(
    fileName: string,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<void>
Delete a pull request attachment.
Parameters
- fileName: string
  The name of the attachment to delete.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.deleteAttachment
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3184

deleteComment

deleteComment(
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    commentId: number,
    project?: string,
): Promise<void>
Delete a comment associated with a specific thread in a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  ID of the thread that the desired comment is in.
- commentId: number
  ID of the comment.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.deleteComment
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5736

deleteEnablementStatus

deleteEnablementStatus(
    allProjects: boolean,
    includeBillableCommitters?: boolean,
    projectIds?: string[],
): Promise<void>
DELETE Deletes Enablement status and BillableCommitters data from DB. Deleting the enablement data will effectively disable it for the repositories affected.
Parameters
- allProjects: boolean
- OptionalincludeBillableCommitters: boolean
- OptionalprojectIds: string[]
Returns Promise<void>
Implementation of IGitApi.deleteEnablementStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:185

deleteLike

deleteLike(
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    commentId: number,
    project?: string,
): Promise<void>
Delete a like on a comment.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  The ID of the thread that contains the comment.
- commentId: number
  The ID of the comment.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.deleteLike
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3419

deletePullRequestIterationStatus

deletePullRequestIterationStatus(
    repositoryId: string,
    pullRequestId: number,
    iterationId: number,
    statusId: number,
    project?: string,
): Promise<void>
Delete pull request iteration status.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- iterationId: number
  ID of the pull request iteration.
- statusId: number
  ID of the pull request status.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.deletePullRequestIterationStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4068

deletePullRequestLabels

deletePullRequestLabels(
    repositoryId: string,
    pullRequestId: number,
    labelIdOrName: string,
    project?: string,
    projectId?: string,
): Promise<void>
Removes a label (tag) from the set of those assigned to the pull request. The tag itself will not be deleted.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- labelIdOrName: string
  The name or ID of the label requested.
- Optionalproject: string
  Project ID or project name
- OptionalprojectId: string
  Project ID or project name.
Returns Promise<void>
Implementation of IGitApi.deletePullRequestLabels
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4337

deletePullRequestReviewer

deletePullRequestReviewer(
    repositoryId: string,
    pullRequestId: number,
    reviewerId: string,
    project?: string,
): Promise<void>
Remove a reviewer from a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- reviewerId: string
  ID of the reviewer to remove.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.deletePullRequestReviewer
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4801

deletePullRequestStatus

deletePullRequestStatus(
    repositoryId: string,
    pullRequestId: number,
    statusId: number,
    project?: string,
): Promise<void>
Delete pull request status.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- statusId: number
  ID of the pull request status.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.deletePullRequestStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5482

deleteRefFavorite

deleteRefFavorite(project: string, favoriteId: number): Promise<void>
Deletes the refs favorite specified
Parameters
- project: string
  Project ID or project name
- favoriteId: number
  The Id of the ref favorite to delete.
Returns Promise<void>
Implementation of IGitApi.deleteRefFavorite
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6724

deleteRepository

deleteRepository(repositoryId: string, project?: string): Promise<void>
Delete a git repository
Parameters
- repositoryId: string
  The ID of the repository.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.deleteRepository
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6959

deleteRepositoryFromRecycleBin

deleteRepositoryFromRecycleBin(
project: string,
repositoryId: string,
): Promise<void>
Destroy (hard delete) a soft-deleted Git repository.
Parameters
- project: string
  Project ID or project name
- repositoryId: string
  The ID of the repository.
Returns Promise<void>
Implementation of IGitApi.deleteRepositoryFromRecycleBin
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6369

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of IGitApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getAnnotatedTag

getAnnotatedTag(
    project: string,
    repositoryId: string,
    objectId: string,
): Promise<GitAnnotatedTag>
Get an annotated tag.
Parameters
- project: string
  Project ID or project name
- repositoryId: string
  ID or name of the repository.
- objectId: string
  ObjectId (Sha1Id) of tag to get.
Returns Promise<GitAnnotatedTag>
Implementation of IGitApi.getAnnotatedTag
- Defined in repos/azure-devops-node-api/api/GitApi.ts:743

getAttachmentContent

getAttachmentContent(
    fileName: string,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<ReadableStream>
Get the file content of a pull request attachment.
Parameters
- fileName: string
  The name of the attachment.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<ReadableStream>
Implementation of IGitApi.getAttachmentContent
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3234

getAttachments

getAttachments(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<Attachment[]>
Get a list of files attached to a given pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<Attachment[]>
Implementation of IGitApi.getAttachments
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3275

getAttachmentZip

getAttachmentZip(
    fileName: string,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<ReadableStream>
Get the file content of a pull request attachment.
Parameters
- fileName: string
  The name of the attachment.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<ReadableStream>
Implementation of IGitApi.getAttachmentZip
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3323

getBillableCommitters

getBillableCommitters(
    project: string,
    billingDate?: Date,
    skip?: number,
    take?: number,
): Promise<BillableCommitter[]>
Retrieve actual billable committers for Advanced Security service for a given date.
Parameters
- project: string
  Project ID or project name
- OptionalbillingDate: Date
  UTC expected. If not specified defaults to the previous billing day.
- Optionalskip: number
  Skip X rows of resultset to simulate paging.
- Optionaltake: number
  Return Y rows of resultset to simulate paging.
Returns Promise<BillableCommitter[]>
Implementation of IGitApi.getBillableCommitters
- Defined in repos/azure-devops-node-api/api/GitApi.ts:791

getBillableCommittersDetail

getBillableCommittersDetail(
    project: string,
    includeDetails: string,
    billingDate?: Date,
): Promise<BillableCommitterDetail[]>
Retrieve detailed actual billable committers for Advanced Security service for a given date. Detailed results intentionally does not filter out soft deleted projects and repositories to help diagnose billing issues.
Parameters
- project: string
  Project ID or project name
- includeDetails: string
  Return all the details on the billable committers.
- OptionalbillingDate: Date
  UTC expected. If not specified defaults to the previous billing day.
Returns Promise<BillableCommitterDetail[]>
Implementation of IGitApi.getBillableCommittersDetail
- Defined in repos/azure-devops-node-api/api/GitApi.ts:844

getBlob

getBlob(
    repositoryId: string,
    sha1: string,
    project?: string,
    download?: boolean,
    fileName?: string,
    resolveLfs?: boolean,
): Promise<GitBlobRef>
Get a single blob.
Parameters
- repositoryId: string
  The name or ID of the repository.
- sha1: string
  SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
- Optionalproject: string
  Project ID or project name
- Optionaldownload: boolean
  If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- OptionalfileName: string
  Provide a fileName to use for a download.
- OptionalresolveLfs: boolean
  If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
Returns Promise<GitBlobRef>
Implementation of IGitApi.getBlob
- Defined in repos/azure-devops-node-api/api/GitApi.ts:901

getBlobContent

getBlobContent(
    repositoryId: string,
    sha1: string,
    project?: string,
    download?: boolean,
    fileName?: string,
    resolveLfs?: boolean,
): Promise<ReadableStream>
Get a single blob.
Parameters
- repositoryId: string
  The name or ID of the repository.
- sha1: string
  SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
- Optionalproject: string
  Project ID or project name
- Optionaldownload: boolean
  If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- OptionalfileName: string
  Provide a fileName to use for a download.
- OptionalresolveLfs: boolean
  If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
Returns Promise<ReadableStream>
Implementation of IGitApi.getBlobContent
- Defined in repos/azure-devops-node-api/api/GitApi.ts:961

getBlobsZip

getBlobsZip(
    blobIds: string[],
    repositoryId: string,
    project?: string,
    filename?: string,
): Promise<ReadableStream>
Gets one or more blobs in a zip file download.
Parameters
- blobIds: string[]
  Blob IDs (SHA1 hashes) to be returned in the zip file.
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- Optionalfilename: string
Returns Promise<ReadableStream>
Implementation of IGitApi.getBlobsZip
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1011

getBlobZip

getBlobZip(
    repositoryId: string,
    sha1: string,
    project?: string,
    download?: boolean,
    fileName?: string,
    resolveLfs?: boolean,
): Promise<ReadableStream>
Get a single blob.
Parameters
- repositoryId: string
  The name or ID of the repository.
- sha1: string
  SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
- Optionalproject: string
  Project ID or project name
- Optionaldownload: boolean
  If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- OptionalfileName: string
  Provide a fileName to use for a download.
- OptionalresolveLfs: boolean
  If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
Returns Promise<ReadableStream>
Implementation of IGitApi.getBlobZip
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1058

getBranch

getBranch(
    repositoryId: string,
    name: string,
    project?: string,
    baseVersionDescriptor?: GitVersionDescriptor,
): Promise<GitBranchStats>
Retrieve statistics about a single branch.
Parameters
- repositoryId: string
  The name or ID of the repository.
- name: string
  Name of the branch.
- Optionalproject: string
  Project ID or project name
- OptionalbaseVersionDescriptor: GitVersionDescriptor
  Identifies the commit or branch to use as the base.
Returns Promise<GitBranchStats>
Implementation of IGitApi.getBranch
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1108

getBranches

getBranches(
    repositoryId: string,
    project?: string,
    baseVersionDescriptor?: GitVersionDescriptor,
): Promise<GitBranchStats[]>
Retrieve statistics about all branches within a repository.
Parameters
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- OptionalbaseVersionDescriptor: GitVersionDescriptor
  Identifies the commit or branch to use as the base.
Returns Promise<GitBranchStats[]>
Implementation of IGitApi.getBranches
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1164

getBranchStatsBatch

getBranchStatsBatch(
    searchCriteria: GitQueryBranchStatsCriteria,
    repositoryId: string,
    project?: string,
): Promise<GitBranchStats[]>
Retrieve statistics for multiple commits
Parameters
- searchCriteria: GitQueryBranchStatsCriteria
  Base Commit and List of Target Commits to compare.
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitBranchStats[]>
Implementation of IGitApi.getBranchStatsBatch
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1215

getChanges

getChanges(
    commitId: string,
    repositoryId: string,
    project?: string,
    top?: number,
    skip?: number,
): Promise<GitCommitChanges>
Retrieve changes for a particular commit.
Parameters
- commitId: string
  The id of the commit.
- repositoryId: string
  The id or friendly name of the repository. To use the friendly name, projectId must also be specified.
- Optionalproject: string
  Project ID or project name
- Optionaltop: number
  The maximum number of changes to return.
- Optionalskip: number
  The number of changes to skip.
Returns Promise<GitCommitChanges>
Implementation of IGitApi.getChanges
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1263

getCherryPick

getCherryPick(
    project: string,
    cherryPickId: number,
    repositoryId: string,
): Promise<GitCherryPick>
Retrieve information about a cherry pick operation by cherry pick Id.
Parameters
- project: string
  Project ID or project name
- cherryPickId: number
  ID of the cherry pick.
- repositoryId: string
  ID of the repository.
Returns Promise<GitCherryPick>
Implementation of IGitApi.getCherryPick
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1635

getCherryPickConflict

getCherryPickConflict(
    repositoryId: string,
    cherryPickId: number,
    conflictId: number,
    project?: string,
): Promise<GitConflict>
Retrieve one conflict for a cherry pick by ID
Parameters
- repositoryId: string
- cherryPickId: number
- conflictId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflict>
Implementation of IGitApi.getCherryPickConflict
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1319

getCherryPickConflicts

getCherryPickConflicts(
    repositoryId: string,
    cherryPickId: number,
    project?: string,
    continuationToken?: string,
    top?: number,
    excludeResolved?: boolean,
    onlyResolved?: boolean,
    includeObsolete?: boolean,
): Promise<PagedList<GitConflict>>
Retrieve all conflicts for a cherry pick
Parameters
- repositoryId: string
- cherryPickId: number
- Optionalproject: string
  Project ID or project name
- OptionalcontinuationToken: string
- Optionaltop: number
- OptionalexcludeResolved: boolean
- OptionalonlyResolved: boolean
- OptionalincludeObsolete: boolean
Returns Promise<PagedList<GitConflict>>
Implementation of IGitApi.getCherryPickConflicts
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1373

getCherryPickForRefName

getCherryPickForRefName(
    project: string,
    repositoryId: string,
    refName: string,
): Promise<GitCherryPick>
Retrieve information about a cherry pick operation for a specific branch. This operation is expensive due to the underlying object structure, so this API only looks at the 1000 most recent cherry pick operations.
Parameters
- project: string
  Project ID or project name
- repositoryId: string
  ID of the repository.
- refName: string
  The GitAsyncRefOperationParameters generatedRefName used for the cherry pick operation.
Returns Promise<GitCherryPick>
Implementation of IGitApi.getCherryPickForRefName
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1682

getCherryPickRelationships

getCherryPickRelationships(
    repositoryNameOrId: string,
    commitId: string,
    project?: string,
    includeLinks?: boolean,
): Promise<GitCommitRef[]>
Given a commitId, returns a list of commits that are in the same cherry-pick family.
Parameters
- repositoryNameOrId: string
- commitId: string
- Optionalproject: string
  Project ID or project name
- OptionalincludeLinks: boolean
Returns Promise<GitCommitRef[]>
Implementation of IGitApi.getCherryPickRelationships
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1536

getComment

getComment(
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    commentId: number,
    project?: string,
): Promise<Comment>
Retrieve a comment associated with a specific thread in a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  ID of the thread that the desired comment is in.
- commentId: number
  ID of the comment.
- Optionalproject: string
  Project ID or project name
Returns Promise<Comment>
Implementation of IGitApi.getComment
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5789

getComments

getComments(
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    project?: string,
): Promise<Comment[]>
Retrieve all comments associated with a specific thread in a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  ID of the thread.
- Optionalproject: string
  Project ID or project name
Returns Promise<Comment[]>
Implementation of IGitApi.getComments
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5841

getCommit

getCommit(
    commitId: string,
    repositoryId: string,
    project?: string,
    changeCount?: number,
): Promise<GitCommit>
Retrieve a particular commit.
Parameters
- commitId: string
  The id of the commit.
- repositoryId: string
  The id or friendly name of the repository. To use the friendly name, projectId must also be specified.
- Optionalproject: string
  Project ID or project name
- OptionalchangeCount: number
  The number of changes to include in the result.
Returns Promise<GitCommit>
Implementation of IGitApi.getCommit
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1808

getCommitDiffs

getCommitDiffs(
    repositoryId: string,
    project?: string,
    diffCommonCommit?: boolean,
    top?: number,
    skip?: number,
    baseVersionDescriptor?: GitBaseVersionDescriptor,
    targetVersionDescriptor?: GitTargetVersionDescriptor,
): Promise<GitCommitDiffs>
Find the closest common commit (the merge base) between base and target commits, and get the diff between either the base and target commits or common and target commits.
Parameters
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- OptionaldiffCommonCommit: boolean
  If true, diff between common and target commits. If false, diff between base and target commits.
- Optionaltop: number
  Maximum number of changes to return. Defaults to 100.
- Optionalskip: number
  Number of changes to skip
- OptionalbaseVersionDescriptor: GitBaseVersionDescriptor
  Descriptor for base commit.
- OptionaltargetVersionDescriptor: GitTargetVersionDescriptor
  Descriptor for target commit.
Returns Promise<GitCommitDiffs>
Implementation of IGitApi.getCommitDiffs
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1740

getCommits

getCommits(
    repositoryId: string,
    searchCriteria: GitQueryCommitsCriteria,
    project?: string,
    skip?: number,
    top?: number,
): Promise<GitCommitRef[]>
Retrieve git commits for a project
Parameters
- repositoryId: string
  The id or friendly name of the repository. To use the friendly name, projectId must also be specified.
- searchCriteria: GitQueryCommitsCriteria
- Optionalproject: string
  Project ID or project name
- Optionalskip: number
- Optionaltop: number
Returns Promise<GitCommitRef[]>
Implementation of IGitApi.getCommits
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1863

getCommitsBatch

getCommitsBatch(
    searchCriteria: GitQueryCommitsCriteria,
    repositoryId: string,
    project?: string,
    skip?: number,
    top?: number,
    includeStatuses?: boolean,
): Promise<GitCommitRef[]>
Retrieve git commits for a project matching the search criteria
Parameters
- searchCriteria: GitQueryCommitsCriteria
  Search options
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- Optionalskip: number
  Number of commits to skip. The value cannot exceed 3,000,000.
- Optionaltop: number
  Maximum number of commits to return. The value cannot exceed 50,000.
- OptionalincludeStatuses: boolean
  True to include additional commit status information.
Returns Promise<GitCommitRef[]>
Implementation of IGitApi.getCommitsBatch
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1987

getDeletedRepositories

getDeletedRepositories(project: string): Promise<GitDeletedRepository[]>
Retrieve deleted git repositories.
Parameters
- project: string
  Project ID or project name
Returns Promise<GitDeletedRepository[]>
Implementation of IGitApi.getDeletedRepositories
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2041

getEnablementStatus

getEnablementStatus(
    projectIds?: string[],
    billingDate?: Date,
    skip?: number,
    take?: number,
): Promise<AdvSecEnablementStatus[]>
GET Enablement status for project's repositories.
Parameters
- OptionalprojectIds: string[]
  Null defaults to all projects in the host, list of project's repos status to return
- OptionalbillingDate: Date
  UTC expected, Null defaults to UtcNow(), can be provided for a point in time status
- Optionalskip: number
  Skip X rows of resultset to simulate paging.
- Optionaltake: number
  Return Y rows of resultset to simulate paging.
Returns Promise<AdvSecEnablementStatus[]>
Implementation of IGitApi.getEnablementStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:240

getEnableOnCreateHost

getEnableOnCreateHost(enableOnCreateHost: boolean): Promise<boolean>
Parameters
- enableOnCreateHost: boolean
Returns Promise<boolean>
Implementation of IGitApi.getEnableOnCreateHost
- Defined in repos/azure-devops-node-api/api/GitApi.ts:289

getEnableOnCreateProject

getEnableOnCreateProject(enableOnCreateProjectId: string): Promise<boolean>
Parameters
- enableOnCreateProjectId: string
Returns Promise<boolean>
Implementation of IGitApi.getEnableOnCreateProject
- Defined in repos/azure-devops-node-api/api/GitApi.ts:335

getEstimatedBillableCommittersRepo

getEstimatedBillableCommittersRepo(
project: string,
repositoryId: string,
): Promise<BillableCommitter[]>
Get estimated billable committers for a repository for the last 90 days.
Parameters
- project: string
  Project ID or project name
- repositoryId: string
Returns Promise<BillableCommitter[]>
Implementation of IGitApi.getEstimatedBillableCommittersRepo
- Defined in repos/azure-devops-node-api/api/GitApi.ts:601

getEstimatedBillablePushersOrg

getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>
Get estimated billable pushers for an Organization for last 90 days.

Returns Promise<BillablePusher[]>
Implementation of IGitApi.getEstimatedBillablePushersOrg
- Defined in repos/azure-devops-node-api/api/GitApi.ts:520

getEstimatedBillablePushersProject

getEstimatedBillablePushersProject(project: string): Promise<BillablePusher[]>
Get estimated billable pushers for a project for last 90 days.
Parameters
- project: string
  Project ID or project name
Returns Promise<BillablePusher[]>
Implementation of IGitApi.getEstimatedBillablePushersProject
- Defined in repos/azure-devops-node-api/api/GitApi.ts:559

getFileDiffs

getFileDiffs(
    fileDiffsCriteria: FileDiffsCriteria,
    project: string,
    repositoryId: string,
): Promise<FileDiff[]>
Get the file diffs for each of the specified files
Parameters
- fileDiffsCriteria: FileDiffsCriteria
  List of file parameters objects
- project: string
  Project ID or project name
- repositoryId: string
  The name or ID of the repository
Returns Promise<FileDiff[]>
Implementation of IGitApi.getFileDiffs
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2084

getForks

getForks(
    repositoryNameOrId: string,
    collectionId: string,
    project?: string,
    includeLinks?: boolean,
): Promise<GitRepositoryRef[]>
Retrieve all forks of a repository in the collection.
Parameters
- repositoryNameOrId: string
  The name or ID of the repository.
- collectionId: string
  Team project collection ID.
- Optionalproject: string
  Project ID or project name
- OptionalincludeLinks: boolean
  True to include links.
Returns Promise<GitRepositoryRef[]>
Implementation of IGitApi.getForks
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2131

getForkSyncRequest

getForkSyncRequest(
    repositoryNameOrId: string,
    forkSyncOperationId: number,
    project?: string,
    includeLinks?: boolean,
): Promise<GitForkSyncRequest>
Get a specific fork sync operation's details.
Parameters
- repositoryNameOrId: string
  The name or ID of the repository.
- forkSyncOperationId: number
  OperationId of the sync request.
- Optionalproject: string
  Project ID or project name
- OptionalincludeLinks: boolean
  True to include links.
Returns Promise<GitForkSyncRequest>
Implementation of IGitApi.getForkSyncRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2238

getForkSyncRequests

getForkSyncRequests(
    repositoryNameOrId: string,
    project?: string,
    includeAbandoned?: boolean,
    includeLinks?: boolean,
): Promise<GitForkSyncRequest[]>
Retrieve all requested fork sync operations on this repository.
Parameters
- repositoryNameOrId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- OptionalincludeAbandoned: boolean
  True to include abandoned requests.
- OptionalincludeLinks: boolean
  True to include links.
Returns Promise<GitForkSyncRequest[]>
Implementation of IGitApi.getForkSyncRequests
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2292

getImportRequest

getImportRequest(
    project: string,
    repositoryId: string,
    importRequestId: number,
): Promise<GitImportRequest>
Retrieve a particular import request.
Parameters
- project: string
  Project ID or project name
- repositoryId: string
  The name or ID of the repository.
- importRequestId: number
  The unique identifier for the import request.
Returns Promise<GitImportRequest>
Implementation of IGitApi.getImportRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2391

getItem

getItem(
    repositoryId: string,
    path: string,
    project?: string,
    scopePath?: string,
    recursionLevel?: VersionControlRecursionType,
    includeContentMetadata?: boolean,
    latestProcessedChange?: boolean,
    download?: boolean,
    versionDescriptor?: GitVersionDescriptor,
    includeContent?: boolean,
    resolveLfs?: boolean,
    sanitize?: boolean,
): Promise<GitItem>
Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
Parameters
- repositoryId: string
  The name or ID of the repository.
- path: string
  The item path.
- Optionalproject: string
  Project ID or project name
- OptionalscopePath: string
  The path scope. The default is null.
- OptionalrecursionLevel: VersionControlRecursionType
  The recursion level of this request. The default is 'none', no recursion.
- OptionalincludeContentMetadata: boolean
  Set to true to include content metadata. Default is false.
- OptionallatestProcessedChange: boolean
  Set to true to include the latest changes. Default is false.
- Optionaldownload: boolean
  Set to true to download the response as a file. Default is false.
- OptionalversionDescriptor: GitVersionDescriptor
  Version descriptor. Default is the default branch for the repository.
- OptionalincludeContent: boolean
  Set to true to include item content when requesting json. Default is false.
- OptionalresolveLfs: boolean
  Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.
- Optionalsanitize: boolean
  Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
Returns Promise<GitItem>
Implementation of IGitApi.getItem
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2547

getItemContent

getItemContent(
    repositoryId: string,
    path: string,
    project?: string,
    scopePath?: string,
    recursionLevel?: VersionControlRecursionType,
    includeContentMetadata?: boolean,
    latestProcessedChange?: boolean,
    download?: boolean,
    versionDescriptor?: GitVersionDescriptor,
    includeContent?: boolean,
    resolveLfs?: boolean,
    sanitize?: boolean,
): Promise<ReadableStream>
Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
Parameters
- repositoryId: string
  The name or ID of the repository.
- path: string
  The item path.
- Optionalproject: string
  Project ID or project name
- OptionalscopePath: string
  The path scope. The default is null.
- OptionalrecursionLevel: VersionControlRecursionType
  The recursion level of this request. The default is 'none', no recursion.
- OptionalincludeContentMetadata: boolean
  Set to true to include content metadata. Default is false.
- OptionallatestProcessedChange: boolean
  Set to true to include the latest changes. Default is false.
- Optionaldownload: boolean
  Set to true to download the response as a file. Default is false.
- OptionalversionDescriptor: GitVersionDescriptor
  Version descriptor. Default is the default branch for the repository.
- OptionalincludeContent: boolean
  Set to true to include item content when requesting json. Default is false.
- OptionalresolveLfs: boolean
  Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.
- Optionalsanitize: boolean
  Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
Returns Promise<ReadableStream>
Implementation of IGitApi.getItemContent
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2628

getItems

getItems(
    repositoryId: string,
    project?: string,
    scopePath?: string,
    recursionLevel?: VersionControlRecursionType,
    includeContentMetadata?: boolean,
    latestProcessedChange?: boolean,
    download?: boolean,
    includeLinks?: boolean,
    versionDescriptor?: GitVersionDescriptor,
    zipForUnix?: boolean,
): Promise<GitItem[]>
Get Item Metadata and/or Content for a collection of items. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.
Parameters
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- OptionalscopePath: string
  The path scope. The default is null.
- OptionalrecursionLevel: VersionControlRecursionType
  The recursion level of this request. The default is 'none', no recursion.
- OptionalincludeContentMetadata: boolean
  Set to true to include content metadata. Default is false.
- OptionallatestProcessedChange: boolean
  Set to true to include the latest changes. Default is false.
- Optionaldownload: boolean
  Set to true to download the response as a file. Default is false.
- OptionalincludeLinks: boolean
  Set to true to include links to items. Default is false.
- OptionalversionDescriptor: GitVersionDescriptor
  Version descriptor. Default is the default branch for the repository.
- OptionalzipForUnix: boolean
  Set to true to keep the file permissions for unix (and POSIX) systems like executables and symlinks
Returns Promise<GitItem[]>
Implementation of IGitApi.getItems
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2699

getItemsBatch

getItemsBatch(
    requestData: GitItemRequestData,
    repositoryId: string,
    project?: string,
): Promise<GitItem[][]>
Post for retrieving a creating a batch out of a set of items in a repo / project given a list of paths or a long path
Parameters
- requestData: GitItemRequestData
  Request data attributes: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Collection of items to fetch, including path, version, and recursion level. IncludeContentMetadata: Whether to include metadata for all items LatestProcessedChange: Whether to include shallow ref to commit that last changed each item. IncludeLinks: Whether to include the _links field on the shallow references.
- repositoryId: string
  The name or ID of the repository
- Optionalproject: string
  Project ID or project name
Returns Promise<GitItem[][]>
Implementation of IGitApi.getItemsBatch
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2910

getItemText

getItemText(
    repositoryId: string,
    path: string,
    project?: string,
    scopePath?: string,
    recursionLevel?: VersionControlRecursionType,
    includeContentMetadata?: boolean,
    latestProcessedChange?: boolean,
    download?: boolean,
    versionDescriptor?: GitVersionDescriptor,
    includeContent?: boolean,
    resolveLfs?: boolean,
    sanitize?: boolean,
): Promise<ReadableStream>
Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
Parameters
- repositoryId: string
  The name or ID of the repository.
- path: string
  The item path.
- Optionalproject: string
  Project ID or project name
- OptionalscopePath: string
  The path scope. The default is null.
- OptionalrecursionLevel: VersionControlRecursionType
  The recursion level of this request. The default is 'none', no recursion.
- OptionalincludeContentMetadata: boolean
  Set to true to include content metadata. Default is false.
- OptionallatestProcessedChange: boolean
  Set to true to include the latest changes. Default is false.
- Optionaldownload: boolean
  Set to true to download the response as a file. Default is false.
- OptionalversionDescriptor: GitVersionDescriptor
  Version descriptor. Default is the default branch for the repository.
- OptionalincludeContent: boolean
  Set to true to include item content when requesting json. Default is false.
- OptionalresolveLfs: boolean
  Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.
- Optionalsanitize: boolean
  Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
Returns Promise<ReadableStream>
Implementation of IGitApi.getItemText
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2773

getItemZip

getItemZip(
    repositoryId: string,
    path: string,
    project?: string,
    scopePath?: string,
    recursionLevel?: VersionControlRecursionType,
    includeContentMetadata?: boolean,
    latestProcessedChange?: boolean,
    download?: boolean,
    versionDescriptor?: GitVersionDescriptor,
    includeContent?: boolean,
    resolveLfs?: boolean,
    sanitize?: boolean,
): Promise<ReadableStream>
Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
Parameters
- repositoryId: string
  The name or ID of the repository.
- path: string
  The item path.
- Optionalproject: string
  Project ID or project name
- OptionalscopePath: string
  The path scope. The default is null.
- OptionalrecursionLevel: VersionControlRecursionType
  The recursion level of this request. The default is 'none', no recursion.
- OptionalincludeContentMetadata: boolean
  Set to true to include content metadata. Default is false.
- OptionallatestProcessedChange: boolean
  Set to true to include the latest changes. Default is false.
- Optionaldownload: boolean
  Set to true to download the response as a file. Default is false.
- OptionalversionDescriptor: GitVersionDescriptor
  Version descriptor. Default is the default branch for the repository.
- OptionalincludeContent: boolean
  Set to true to include item content when requesting json. Default is false.
- OptionalresolveLfs: boolean
  Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.
- Optionalsanitize: boolean
  Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
Returns Promise<ReadableStream>
Implementation of IGitApi.getItemZip
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2846

getLikes

getLikes(
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    commentId: number,
    project?: string,
): Promise<IdentityRef[]>
Get likes for a comment.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  The ID of the thread that contains the comment.
- commentId: number
  The ID of the comment.
- Optionalproject: string
  Project ID or project name
Returns Promise<IdentityRef[]>
Implementation of IGitApi.getLikes
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3472

getMergeBases

getMergeBases(
    repositoryNameOrId: string,
    commitId: string,
    otherCommitId: string,
    project?: string,
    otherCollectionId?: string,
    otherRepositoryId?: string,
): Promise<GitCommitRef[]>
Find the merge bases of two commits, optionally across forks. If otherRepositoryId is not specified, the merge bases will only be calculated within the context of the local repositoryNameOrId.
Parameters
- repositoryNameOrId: string
  ID or name of the local repository.
- commitId: string
  First commit, usually the tip of the target branch of the potential merge.
- otherCommitId: string
  Other commit, usually the tip of the source branch of the potential merge.
- Optionalproject: string
  Project ID or project name
- OptionalotherCollectionId: string
  The collection ID where otherCommitId lives.
- OptionalotherRepositoryId: string
  The repository ID where otherCommitId lives.
Returns Promise<GitCommitRef[]>
Implementation of IGitApi.getMergeBases
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2959

getMergeRequest

getMergeRequest(
    project: string,
    repositoryNameOrId: string,
    mergeOperationId: number,
    includeLinks?: boolean,
): Promise<GitMerge>
Get a specific merge operation's details.
Parameters
- project: string
  Project ID or project name
- repositoryNameOrId: string
  The name or ID of the repository.
- mergeOperationId: number
  OperationId of the merge request.
- OptionalincludeLinks: boolean
  True to include links
Returns Promise<GitMerge>
Implementation of IGitApi.getMergeRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3073

getPermission

getPermission(
    projectName?: string,
    repositoryId?: string,
    permission?: string,
): Promise<boolean>
GET Advanced Security Permission status.
Parameters
- OptionalprojectName: string
- OptionalrepositoryId: string
  Repository user is trying to access
- Optionalpermission: string
  Permission being requestd, must be "viewAlert" "dismissAlert" "manage" "viewEnablement" or "repoRead"
Returns Promise<boolean>
Implementation of IGitApi.getPermission
- Defined in repos/azure-devops-node-api/api/GitApi.ts:646

getPullRequest

getPullRequest(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
    maxCommentLength?: number,
    skip?: number,
    top?: number,
    includeCommits?: boolean,
    includeWorkItemRefs?: boolean,
): Promise<GitPullRequest>
Retrieve a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  The ID of the pull request to retrieve.
- Optionalproject: string
  Project ID or project name
- OptionalmaxCommentLength: number
  Not used.
- Optionalskip: number
  Not used.
- Optionaltop: number
  Not used.
- OptionalincludeCommits: boolean
  If true, the pull request will be returned with the associated commits.
- OptionalincludeWorkItemRefs: boolean
  If true, the pull request will be returned with the associated work item references.
Returns Promise<GitPullRequest>
Implementation of IGitApi.getPullRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5210

getPullRequestById

getPullRequestById(
pullRequestId: number,
project?: string,
): Promise<GitPullRequest>
Retrieve a pull request.
Parameters
- pullRequestId: number
  The ID of the pull request to retrieve.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequest>
Implementation of IGitApi.getPullRequestById
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5047

getPullRequestCommits

getPullRequestCommits(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<PagedList<GitCommitRef>>
Get the commits for the specified pull request.
Parameters
- repositoryId: string
  ID or name of the repository.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<PagedList<GitCommitRef>>
Implementation of IGitApi.getPullRequestCommits
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3583

getPullRequestConflict

getPullRequestConflict(
    repositoryId: string,
    pullRequestId: number,
    conflictId: number,
    project?: string,
): Promise<GitConflict>
Retrieve one conflict for a pull request by ID
Parameters
- repositoryId: string
- pullRequestId: number
- conflictId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflict>
Implementation of IGitApi.getPullRequestConflict
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3631

getPullRequestConflicts

getPullRequestConflicts(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
    skip?: number,
    top?: number,
    includeObsolete?: boolean,
    excludeResolved?: boolean,
    onlyResolved?: boolean,
): Promise<GitConflict[]>
Retrieve all conflicts for a pull request
Parameters
- repositoryId: string
  The repository of the Pull Request.
- pullRequestId: number
  The pull request ID.
- Optionalproject: string
  Project ID or project name
- Optionalskip: number
  Conflicts to skip.
- Optionaltop: number
  Conflicts to return after skip.
- OptionalincludeObsolete: boolean
  Includes obsolete conflicts.
- OptionalexcludeResolved: boolean
  Excludes conflicts already resolved.
- OptionalonlyResolved: boolean
  Returns only the conflicts that are resolved.
Returns Promise<GitConflict[]>
Implementation of IGitApi.getPullRequestConflicts
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3685

getPullRequestIteration

getPullRequestIteration(
    repositoryId: string,
    pullRequestId: number,
    iterationId: number,
    project?: string,
): Promise<GitPullRequestIteration>
Get the specified iteration for a pull request.
Parameters
- repositoryId: string
  ID or name of the repository.
- pullRequestId: number
  ID of the pull request.
- iterationId: number
  ID of the pull request iteration to return.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestIteration>
Implementation of IGitApi.getPullRequestIteration
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3911

getPullRequestIterationChanges

getPullRequestIterationChanges(
    repositoryId: string,
    pullRequestId: number,
    iterationId: number,
    project?: string,
    top?: number,
    skip?: number,
    compareTo?: number,
): Promise<GitPullRequestIterationChanges>
Retrieve the changes made in a pull request between two iterations.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- iterationId: number
  ID of the pull request iteration.
  Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch. Allowed values are between 1 and the maximum iteration on this pull request.
- Optionalproject: string
  Project ID or project name
- Optionaltop: number
  Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.
- Optionalskip: number
  Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.
- OptionalcompareTo: number
  ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches
Returns Promise<GitPullRequestIterationChanges>
Implementation of IGitApi.getPullRequestIterationChanges
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3851

getPullRequestIterationCommits

getPullRequestIterationCommits(
    repositoryId: string,
    pullRequestId: number,
    iterationId: number,
    project?: string,
    top?: number,
    skip?: number,
): Promise<GitCommitRef[]>
Get the commits for the specified iteration of a pull request.
Parameters
- repositoryId: string
  ID or name of the repository.
- pullRequestId: number
  ID of the pull request.
- iterationId: number
  ID of the iteration from which to get the commits.
- Optionalproject: string
  Project ID or project name
- Optionaltop: number
  Maximum number of commits to return. The maximum number of commits that can be returned per batch is 500.
- Optionalskip: number
  Number of commits to skip.
Returns Promise<GitCommitRef[]>
Implementation of IGitApi.getPullRequestIterationCommits
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3526

getPullRequestIterations

getPullRequestIterations(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
    includeCommits?: boolean,
): Promise<GitPullRequestIteration[]>
Get the list of iterations for the specified pull request.
Parameters
- repositoryId: string
  ID or name of the repository.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
- OptionalincludeCommits: boolean
  If true, include the commits associated with each iteration in the response.
Returns Promise<GitPullRequestIteration[]>
Implementation of IGitApi.getPullRequestIterations
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3961

getPullRequestIterationStatus

getPullRequestIterationStatus(
    repositoryId: string,
    pullRequestId: number,
    iterationId: number,
    statusId: number,
    project?: string,
): Promise<GitPullRequestStatus>
Get the specific pull request iteration status by ID. The status ID is unique within the pull request across all iterations.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- iterationId: number
  ID of the pull request iteration.
- statusId: number
  ID of the pull request status.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestStatus>
Implementation of IGitApi.getPullRequestIterationStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4121

getPullRequestIterationStatuses

getPullRequestIterationStatuses(
    repositoryId: string,
    pullRequestId: number,
    iterationId: number,
    project?: string,
): Promise<GitPullRequestStatus[]>
Get all the statuses associated with a pull request iteration.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- iterationId: number
  ID of the pull request iteration.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestStatus[]>
Implementation of IGitApi.getPullRequestIterationStatuses
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4173

getPullRequestLabel

getPullRequestLabel(
    repositoryId: string,
    pullRequestId: number,
    labelIdOrName: string,
    project?: string,
    projectId?: string,
): Promise<WebApiTagDefinition>
Retrieves a single label (tag) that has been assigned to a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- labelIdOrName: string
  The name or ID of the label requested.
- Optionalproject: string
  Project ID or project name
- OptionalprojectId: string
  Project ID or project name.
Returns Promise<WebApiTagDefinition>
Implementation of IGitApi.getPullRequestLabel
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4394

getPullRequestLabels

getPullRequestLabels(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
    projectId?: string,
): Promise<WebApiTagDefinition[]>
Get all the labels (tags) assigned to a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
- OptionalprojectId: string
  Project ID or project name.
Returns Promise<WebApiTagDefinition[]>
Implementation of IGitApi.getPullRequestLabels
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4450

getPullRequestProperties

getPullRequestProperties(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<any>
Get external properties of the pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<any>
Implementation of IGitApi.getPullRequestProperties
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4503

getPullRequestQuery

getPullRequestQuery(
    queries: GitPullRequestQuery,
    repositoryId: string,
    project?: string,
): Promise<GitPullRequestQuery>
This API is used to find what pull requests are related to a given commit. It can be used to either find the pull request that created a particular merge commit or it can be used to find all pull requests that have ever merged a particular commit. The input is a list of queries which each contain a list of commits. For each commit that you search against, you will get back a dictionary of commit -> pull requests.
Parameters
- queries: GitPullRequestQuery
  The list of queries to perform.
- repositoryId: string
  ID of the repository.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestQuery>
Implementation of IGitApi.getPullRequestQuery
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4604

getPullRequestReviewer

getPullRequestReviewer(
    repositoryId: string,
    pullRequestId: number,
    reviewerId: string,
    project?: string,
): Promise<IdentityRefWithVote>
Retrieve information about a particular reviewer on a pull request
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- reviewerId: string
  ID of the reviewer.
- Optionalproject: string
  Project ID or project name
Returns Promise<IdentityRefWithVote>
Implementation of IGitApi.getPullRequestReviewer
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4851

getPullRequestReviewers

getPullRequestReviewers(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<IdentityRefWithVote[]>
Retrieve the reviewers for a pull request
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<IdentityRefWithVote[]>
Implementation of IGitApi.getPullRequestReviewers
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4900

getPullRequests

getPullRequests(
    repositoryId: string,
    searchCriteria: GitPullRequestSearchCriteria,
    project?: string,
    maxCommentLength?: number,
    skip?: number,
    top?: number,
): Promise<GitPullRequest[]>
Retrieve all pull requests matching a specified criteria.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- searchCriteria: GitPullRequestSearchCriteria
  Pull requests will be returned that match this search criteria.
- Optionalproject: string
  Project ID or project name
- OptionalmaxCommentLength: number
  Not used.
- Optionalskip: number
  The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
- Optionaltop: number
  The number of pull requests to retrieve.
Returns Promise<GitPullRequest[]>
Implementation of IGitApi.getPullRequests
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5274

getPullRequestsByProject

getPullRequestsByProject(
    project: string,
    searchCriteria: GitPullRequestSearchCriteria,
    maxCommentLength?: number,
    skip?: number,
    top?: number,
): Promise<GitPullRequest[]>
Retrieve all pull requests matching a specified criteria.
Parameters
- project: string
  Project ID or project name
- searchCriteria: GitPullRequestSearchCriteria
  Pull requests will be returned that match this search criteria.
- OptionalmaxCommentLength: number
  Not used.
- Optionalskip: number
  The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
- Optionaltop: number
  The number of pull requests to retrieve.
Returns Promise<GitPullRequest[]>
Implementation of IGitApi.getPullRequestsByProject
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5094

getPullRequestStatus

getPullRequestStatus(
    repositoryId: string,
    pullRequestId: number,
    statusId: number,
    project?: string,
): Promise<GitPullRequestStatus>
Get the specific pull request status by ID. The status ID is unique within the pull request across all iterations.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- statusId: number
  ID of the pull request status.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestStatus>
Implementation of IGitApi.getPullRequestStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5532

getPullRequestStatuses

getPullRequestStatuses(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<GitPullRequestStatus[]>
Get all the statuses associated with a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestStatus[]>
Implementation of IGitApi.getPullRequestStatuses
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5581

getPullRequestThread

getPullRequestThread(
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    project?: string,
    iteration?: number,
    baseIteration?: number,
): Promise<GitPullRequestCommentThread>
Retrieve a thread in a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  ID of the thread.
- Optionalproject: string
  Project ID or project name
- Optionaliteration: number
  If specified, thread position will be tracked using this iteration as the right side of the diff.
- OptionalbaseIteration: number
  If specified, thread position will be tracked using this iteration as the left side of the diff.
Returns Promise<GitPullRequestCommentThread>
Implementation of IGitApi.getPullRequestThread
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5997

getPullRequestWorkItemRefs

getPullRequestWorkItemRefs(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<ResourceRef[]>
Retrieve a list of work items associated with a pull request.
Parameters
- repositoryId: string
  ID or name of the repository.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<ResourceRef[]>
Implementation of IGitApi.getPullRequestWorkItemRefs
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6163

getPush

getPush(
    repositoryId: string,
    pushId: number,
    project?: string,
    includeCommits?: number,
    includeRefUpdates?: boolean,
): Promise<GitPush>
Retrieves a particular push.
Parameters
- repositoryId: string
  The name or ID of the repository.
- pushId: number
  ID of the push.
- Optionalproject: string
  Project ID or project name
- OptionalincludeCommits: number
  The number of commits to include in the result.
- OptionalincludeRefUpdates: boolean
  If true, include the list of refs that were updated by the push.
Returns Promise<GitPush>
Implementation of IGitApi.getPush
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6258

getPushCommits

getPushCommits(
    repositoryId: string,
    pushId: number,
    project?: string,
    top?: number,
    skip?: number,
    includeLinks?: boolean,
): Promise<GitCommitRef[]>
Retrieve a list of commits associated with a particular push.
Parameters
- repositoryId: string
  The id or friendly name of the repository. To use the friendly name, projectId must also be specified.
- pushId: number
  The id of the push.
- Optionalproject: string
  Project ID or project name
- Optionaltop: number
  The maximum number of commits to return ("get the top x commits").
- Optionalskip: number
  The number of commits to skip.
- OptionalincludeLinks: boolean
  Set to false to avoid including REST Url links for resources. Defaults to true.
Returns Promise<GitCommitRef[]>
Implementation of IGitApi.getPushCommits
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1924

getPushes

getPushes(
    repositoryId: string,
    project?: string,
    skip?: number,
    top?: number,
    searchCriteria?: GitPushSearchCriteria,
): Promise<GitPush[]>
Retrieves pushes associated with the specified repository.
Parameters
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- Optionalskip: number
  Number of pushes to skip.
- Optionaltop: number
  Number of pushes to return.
- OptionalsearchCriteria: GitPushSearchCriteria
  Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.
Returns Promise<GitPush[]>
Implementation of IGitApi.getPushes
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6315

getRecycleBinRepositories

getRecycleBinRepositories(project: string): Promise<GitDeletedRepository[]>
Retrieve soft-deleted git repositories from the recycle bin.
Parameters
- project: string
  Project ID or project name
Returns Promise<GitDeletedRepository[]>
Implementation of IGitApi.getRecycleBinRepositories
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6412

getRefFavorite

getRefFavorite(project: string, favoriteId: number): Promise<GitRefFavorite>
Gets the refs favorite for a favorite Id.
Parameters
- project: string
  Project ID or project name
- favoriteId: number
  The Id of the requested ref favorite.
Returns Promise<GitRefFavorite>
Implementation of IGitApi.getRefFavorite
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6768

getRefFavorites

getRefFavorites(
    project: string,
    repositoryId?: string,
    identityId?: string,
): Promise<GitRefFavorite[]>
Gets the refs favorites for a repo and an identity.
Parameters
- project: string
  Project ID or project name
- OptionalrepositoryId: string
  The id of the repository.
- OptionalidentityId: string
  The id of the identity whose favorites are to be retrieved. If null, the requesting identity is used.
Returns Promise<GitRefFavorite[]>
Implementation of IGitApi.getRefFavorites
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6813

getRefFavoritesForProject

getRefFavoritesForProject(
project: string,
identityId?: string,
): Promise<GitRefFavorite[]>
Parameters
- project: string
  Project ID or project name
- OptionalidentityId: string
Returns Promise<GitRefFavorite[]>
Implementation of IGitApi.getRefFavoritesForProject
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6861

getRefs

getRefs(
    repositoryId: string,
    project?: string,
    filter?: string,
    includeLinks?: boolean,
    includeStatuses?: boolean,
    includeMyBranches?: boolean,
    latestStatusesOnly?: boolean,
    peelTags?: boolean,
    filterContains?: string,
): Promise<PagedList<GitRef>>
Queries the provided repository for its refs and returns them.
Parameters
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- Optionalfilter: string
  [optional] A filter to apply to the refs (starts with).
- OptionalincludeLinks: boolean
  [optional] Specifies if referenceLinks should be included in the result. default is false.
- OptionalincludeStatuses: boolean
  [optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.
- OptionalincludeMyBranches: boolean
  [optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.
- OptionallatestStatusesOnly: boolean
  [optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
- OptionalpeelTags: boolean
  [optional] Annotated tags will populate the PeeledObjectId property. default is false.
- OptionalfilterContains: string
  [optional] A filter to apply to the refs (contains).
Returns Promise<PagedList<GitRef>>
Implementation of IGitApi.getRefs
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6507

getRepositories

getRepositories(
    project?: string,
    includeLinks?: boolean,
    includeAllUrls?: boolean,
    includeHidden?: boolean,
): Promise<GitRepository[]>
Retrieve git repositories.
Parameters
- Optionalproject: string
  Project ID or project name
- OptionalincludeLinks: boolean
  [optional] True to include reference links. The default value is false.
- OptionalincludeAllUrls: boolean
  [optional] True to include all remote URLs. The default value is false.
- OptionalincludeHidden: boolean
  [optional] True to include hidden repositories. The default value is false.
Returns Promise<GitRepository[]>
Implementation of IGitApi.getRepositories
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7005

getRepository

getRepository(repositoryId: string, project?: string): Promise<GitRepository>
Retrieve a git repository.
Parameters
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitRepository>
Implementation of IGitApi.getRepository
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7057

getRepositoryWithParent

getRepositoryWithParent(
    repositoryId: string,
    includeParent: boolean,
    project?: string,
): Promise<GitRepository>
Retrieve a git repository.
Parameters
- repositoryId: string
  The name or ID of the repository.
- includeParent: boolean
  True to include parent repository. Only available in authenticated calls.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitRepository>
Implementation of IGitApi.getRepositoryWithParent
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7102

getRevert

getRevert(
    project: string,
    revertId: number,
    repositoryId: string,
): Promise<GitRevert>
Retrieve information about a revert operation by revert Id.
Parameters
- project: string
  Project ID or project name
- revertId: number
  ID of the revert operation.
- repositoryId: string
  ID of the repository.
Returns Promise<GitRevert>
Implementation of IGitApi.getRevert
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7465

getRevertConflict

getRevertConflict(
    repositoryId: string,
    revertId: number,
    conflictId: number,
    project?: string,
): Promise<GitConflict>
Retrieve one conflict for a revert by ID
Parameters
- repositoryId: string
- revertId: number
- conflictId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflict>
Implementation of IGitApi.getRevertConflict
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7203

getRevertConflicts

getRevertConflicts(
    repositoryId: string,
    revertId: number,
    project?: string,
    continuationToken?: string,
    top?: number,
    excludeResolved?: boolean,
    onlyResolved?: boolean,
    includeObsolete?: boolean,
): Promise<PagedList<GitConflict>>
Retrieve all conflicts for a revert
Parameters
- repositoryId: string
- revertId: number
- Optionalproject: string
  Project ID or project name
- OptionalcontinuationToken: string
- Optionaltop: number
- OptionalexcludeResolved: boolean
- OptionalonlyResolved: boolean
- OptionalincludeObsolete: boolean
Returns Promise<PagedList<GitConflict>>
Implementation of IGitApi.getRevertConflicts
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7257

getRevertForRefName

getRevertForRefName(
    project: string,
    repositoryId: string,
    refName: string,
): Promise<GitRevert>
Retrieve information about a revert operation for a specific branch.
Parameters
- project: string
  Project ID or project name
- repositoryId: string
  ID of the repository.
- refName: string
  The GitAsyncRefOperationParameters generatedRefName used for the revert operation.
Returns Promise<GitRevert>
Implementation of IGitApi.getRevertForRefName
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7512

getStatuses

getStatuses(
    commitId: string,
    repositoryId: string,
    project?: string,
    top?: number,
    skip?: number,
    latestOnly?: boolean,
): Promise<GitStatus[]>
Get statuses associated with the Git commit.
Parameters
- commitId: string
  ID of the Git commit.
- repositoryId: string
  ID of the repository.
- Optionalproject: string
  Project ID or project name
- Optionaltop: number
  Optional. The number of statuses to retrieve. Default is 1000.
- Optionalskip: number
  Optional. The number of statuses to ignore. Default is 0. For example, to retrieve results 101-150, set top to 50 and skip to 100.
- OptionallatestOnly: boolean
  The flag indicates whether to get only latest statuses grouped by Context.Name and Context.Genre.
Returns Promise<GitStatus[]>
Implementation of IGitApi.getStatuses
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7618

getSuggestions

getSuggestions(
    repositoryId: string,
    project?: string,
    preferCompareBranch?: boolean,
): Promise<GitSuggestion[]>
Retrieve a pull request suggestion for a particular repository or team project.
Parameters
- repositoryId: string
  ID of the git repository.
- Optionalproject: string
  Project ID or project name
- OptionalpreferCompareBranch: boolean
  If true, prefer the compare branch over the default branch as target branch for pull requests.
Returns Promise<GitSuggestion[]>
Implementation of IGitApi.getSuggestions
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7675

getThreads

getThreads(
    repositoryId: string,
    pullRequestId: number,
    project?: string,
    iteration?: number,
    baseIteration?: number,
): Promise<GitPullRequestCommentThread[]>
Retrieve all threads in a pull request.
Parameters
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
- Optionaliteration: number
  If specified, thread positions will be tracked using this iteration as the right side of the diff.
- OptionalbaseIteration: number
  If specified, thread positions will be tracked using this iteration as the left side of the diff.
Returns Promise<GitPullRequestCommentThread[]>
Implementation of IGitApi.getThreads
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6056

getTree

getTree(
    repositoryId: string,
    sha1: string,
    project?: string,
    projectId?: string,
    recursive?: boolean,
    fileName?: string,
): Promise<GitTreeRef>
The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.
Parameters
- repositoryId: string
  Repository Id.
- sha1: string
  SHA1 hash of the tree object.
- Optionalproject: string
  Project ID or project name
- OptionalprojectId: string
  Project Id.
- Optionalrecursive: boolean
  Search recursively. Include trees underneath this tree. Default is false.
- OptionalfileName: string
  Name to use if a .zip file is returned. Default is the object ID.
Returns Promise<GitTreeRef>
Implementation of IGitApi.getTree
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7729

getTreeZip

getTreeZip(
    repositoryId: string,
    sha1: string,
    project?: string,
    projectId?: string,
    recursive?: boolean,
    fileName?: string,
): Promise<ReadableStream>
The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.
Parameters
- repositoryId: string
  Repository Id.
- sha1: string
  SHA1 hash of the tree object.
- Optionalproject: string
  Project ID or project name
- OptionalprojectId: string
  Project Id.
- Optionalrecursive: boolean
  Search recursively. Include trees underneath this tree. Default is false.
- OptionalfileName: string
  Name to use if a .zip file is returned. Default is the object ID.
Returns Promise<ReadableStream>
Implementation of IGitApi.getTreeZip
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7789

queryImportRequests

queryImportRequests(
    project: string,
    repositoryId: string,
    includeAbandoned?: boolean,
): Promise<GitImportRequest[]>
Retrieve import requests for a repository.
Parameters
- project: string
  Project ID or project name
- repositoryId: string
  The name or ID of the repository.
- OptionalincludeAbandoned: boolean
  True to include abandoned import requests in the results.
Returns Promise<GitImportRequest[]>
Implementation of IGitApi.queryImportRequests
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2438

restoreRepositoryFromRecycleBin

restoreRepositoryFromRecycleBin(
    repositoryDetails: GitRecycleBinRepositoryDetails,
    project: string,
    repositoryId: string,
): Promise<GitRepository>
Recover a soft-deleted Git repository. Recently deleted repositories go into a soft-delete state for a period of time before they are hard deleted and become unrecoverable.
Parameters
- repositoryDetails: GitRecycleBinRepositoryDetails
- project: string
  Project ID or project name
- repositoryId: string
  The ID of the repository.
Returns Promise<GitRepository>
Implementation of IGitApi.restoreRepositoryFromRecycleBin
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6455

setEnableOnCreateHost

setEnableOnCreateHost(enableOnCreateHost: boolean): Promise<void>
Parameters
- enableOnCreateHost: boolean
Returns Promise<void>
Implementation of IGitApi.setEnableOnCreateHost
- Defined in repos/azure-devops-node-api/api/GitApi.ts:381

setEnableOnCreateProject

setEnableOnCreateProject(
enableOnCreateProjectId: string,
enableOnStatus: boolean,
): Promise<void>
Parameters
- enableOnCreateProjectId: string
- enableOnStatus: boolean
Returns Promise<void>
Implementation of IGitApi.setEnableOnCreateProject
- Defined in repos/azure-devops-node-api/api/GitApi.ts:428

sharePullRequest

sharePullRequest(
    userMessage: ShareNotificationContext,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<void>
Sends an e-mail notification about a specific pull request to a set of recipients
Parameters
- userMessage: ShareNotificationContext
- repositoryId: string
  ID of the git repository.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.sharePullRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5384

updateCherryPickConflict

updateCherryPickConflict(
    conflict: GitConflict,
    repositoryId: string,
    cherryPickId: number,
    conflictId: number,
    project?: string,
): Promise<GitConflict>
Update merge conflict resolution
Parameters
- conflict: GitConflict
- repositoryId: string
- cherryPickId: number
- conflictId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflict>
Implementation of IGitApi.updateCherryPickConflict
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1436

updateCherryPickConflicts

updateCherryPickConflicts(
    conflictUpdates: GitConflict[],
    repositoryId: string,
    cherryPickId: number,
    project?: string,
): Promise<GitConflictUpdateResult[]>
Update multiple merge conflict resolutions
Parameters
- conflictUpdates: GitConflict[]
- repositoryId: string
- cherryPickId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflictUpdateResult[]>
Implementation of IGitApi.updateCherryPickConflicts
- Defined in repos/azure-devops-node-api/api/GitApi.ts:1487

updateComment

updateComment(
    comment: Comment,
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    commentId: number,
    project?: string,
): Promise<Comment>
Update a comment associated with a specific thread in a pull request.
Parameters
- comment: Comment
  The comment content that should be updated. Comments can be up to 150,000 characters.
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  ID of the thread that the desired comment is in.
- commentId: number
  ID of the comment to update.
- Optionalproject: string
  Project ID or project name
Returns Promise<Comment>
Implementation of IGitApi.updateComment
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5893

updateEnablementStatus

updateEnablementStatus(
enablementUpdates: AdvSecEnablementUpdate[],
): Promise<void>
POST Enablement status for repositories.
Parameters
- enablementUpdates: AdvSecEnablementUpdate[]
Returns Promise<void>
Implementation of IGitApi.updateEnablementStatus
- Defined in repos/azure-devops-node-api/api/GitApi.ts:481

updateImportRequest

updateImportRequest(
    importRequestToUpdate: GitImportRequest,
    project: string,
    repositoryId: string,
    importRequestId: number,
): Promise<GitImportRequest>
Retry or abandon a failed import request.
Parameters
- importRequestToUpdate: GitImportRequest
  The updated version of the import request. Currently, the only change allowed is setting the Status to Queued or Abandoned.
- project: string
  Project ID or project name
- repositoryId: string
  The name or ID of the repository.
- importRequestId: number
  The unique identifier for the import request to update.
Returns Promise<GitImportRequest>
Implementation of IGitApi.updateImportRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:2490

updatePullRequest

updatePullRequest(
    gitPullRequestToUpdate: GitPullRequest,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<GitPullRequest>
Update a pull request
Parameters
- gitPullRequestToUpdate: GitPullRequest
  The pull request content that should be updated.
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request to update.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequest>
Implementation of IGitApi.updatePullRequest
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5335

updatePullRequestConflict

updatePullRequestConflict(
    conflict: GitConflict,
    repositoryId: string,
    pullRequestId: number,
    conflictId: number,
    project?: string,
): Promise<GitConflict>
Update merge conflict resolution
Parameters
- conflict: GitConflict
- repositoryId: string
- pullRequestId: number
- conflictId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflict>
Implementation of IGitApi.updatePullRequestConflict
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3748

updatePullRequestConflicts

updatePullRequestConflicts(
    conflictUpdates: GitConflict[],
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<GitConflictUpdateResult[]>
Update multiple merge conflict resolutions
Parameters
- conflictUpdates: GitConflict[]
- repositoryId: string
- pullRequestId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflictUpdateResult[]>
Implementation of IGitApi.updatePullRequestConflicts
- Defined in repos/azure-devops-node-api/api/GitApi.ts:3799

updatePullRequestIterationStatuses

updatePullRequestIterationStatuses(
    customHeaders: any,
    patchDocument: JsonPatchDocument,
    repositoryId: string,
    pullRequestId: number,
    iterationId: number,
    project?: string,
): Promise<void>
Update pull request iteration statuses collection. The only supported operation type is remove.
Parameters
- customHeaders: any
- patchDocument: JsonPatchDocument
  Operations to apply to the pull request statuses in JSON Patch format.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- iterationId: number
  ID of the pull request iteration.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.updatePullRequestIterationStatuses
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4224

updatePullRequestProperties

updatePullRequestProperties(
    customHeaders: any,
    patchDocument: JsonPatchDocument,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<any>
Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.
Parameters
- customHeaders: any
- patchDocument: JsonPatchDocument
  Properties to add, replace or remove in JSON Patch format.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<any>
Implementation of IGitApi.updatePullRequestProperties
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4551

updatePullRequestReviewer

updatePullRequestReviewer(
    reviewer: IdentityRefWithVote,
    repositoryId: string,
    pullRequestId: number,
    reviewerId: string,
    project?: string,
): Promise<IdentityRefWithVote>
Edit a reviewer entry. These fields are patchable: isFlagged, hasDeclined
Parameters
- reviewer: IdentityRefWithVote
  Reviewer data.
  If the reviewer's ID is included here, it must match the reviewerID parameter.
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- reviewerId: string
  ID of the reviewer.
- Optionalproject: string
  Project ID or project name
Returns Promise<IdentityRefWithVote>
Implementation of IGitApi.updatePullRequestReviewer
- Defined in repos/azure-devops-node-api/api/GitApi.ts:4949

updatePullRequestReviewers

updatePullRequestReviewers(
    patchVotes: IdentityRefWithVote[],
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<void>
Reset the votes of multiple reviewers on a pull request. NOTE: This endpoint only supports updating votes, but does not support updating required reviewers (use policy) or display names.
Parameters
- patchVotes: IdentityRefWithVote[]
  IDs of the reviewers whose votes will be reset to zero
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.updatePullRequestReviewers
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5000

updatePullRequestStatuses

updatePullRequestStatuses(
    customHeaders: any,
    patchDocument: JsonPatchDocument,
    repositoryId: string,
    pullRequestId: number,
    project?: string,
): Promise<void>
Update pull request statuses collection. The only supported operation type is remove.
Parameters
- customHeaders: any
- patchDocument: JsonPatchDocument
  Operations to apply to the pull request statuses in JSON Patch format.
- repositoryId: string
  The repository ID of the pull request’s target branch.
- pullRequestId: number
  ID of the pull request.
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of IGitApi.updatePullRequestStatuses
- Defined in repos/azure-devops-node-api/api/GitApi.ts:5629

updateRef

updateRef(
    newRefInfo: GitRefUpdate,
    repositoryId: string,
    filter: string,
    project?: string,
    projectId?: string,
): Promise<GitRef>
Lock or Unlock a branch.
Parameters
- newRefInfo: GitRefUpdate
  The ref update action (lock/unlock) to perform
- repositoryId: string
  The name or ID of the repository.
- filter: string
  The name of the branch to lock/unlock
- Optionalproject: string
  Project ID or project name
- OptionalprojectId: string
  ID or name of the team project. Optional if specifying an ID for repository.
Returns Promise<GitRef>
Implementation of IGitApi.updateRef
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6572

updateRefs

updateRefs(
    refUpdates: GitRefUpdate[],
    repositoryId: string,
    project?: string,
    projectId?: string,
): Promise<GitRefUpdateResult[]>
Creating, updating, or deleting refs(branches).
Parameters
- refUpdates: GitRefUpdate[]
  List of ref updates to attempt to perform
- repositoryId: string
  The name or ID of the repository.
- Optionalproject: string
  Project ID or project name
- OptionalprojectId: string
  ID or name of the team project. Optional if specifying an ID for repository.
Returns Promise<GitRefUpdateResult[]>
Implementation of IGitApi.updateRefs
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6630

updateRepository

updateRepository(
    newRepositoryInfo: GitRepository,
    repositoryId: string,
    project?: string,
): Promise<GitRepository>
Updates the Git repository with either a new repo name or a new default branch.
Parameters
- newRepositoryInfo: GitRepository
  Specify a new repo name or a new default branch of the repository
- repositoryId: string
  The ID of the repository.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitRepository>
Implementation of IGitApi.updateRepository
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7156

updateRevertConflict

updateRevertConflict(
    conflict: GitConflict,
    repositoryId: string,
    revertId: number,
    conflictId: number,
    project?: string,
): Promise<GitConflict>
Update merge conflict resolution
Parameters
- conflict: GitConflict
- repositoryId: string
- revertId: number
- conflictId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflict>
Implementation of IGitApi.updateRevertConflict
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7320

updateRevertConflicts

updateRevertConflicts(
    conflictUpdates: GitConflict[],
    repositoryId: string,
    revertId: number,
    project?: string,
): Promise<GitConflictUpdateResult[]>
Update multiple merge conflict resolutions
Parameters
- conflictUpdates: GitConflict[]
- repositoryId: string
- revertId: number
- Optionalproject: string
  Project ID or project name
Returns Promise<GitConflictUpdateResult[]>
Implementation of IGitApi.updateRevertConflicts
- Defined in repos/azure-devops-node-api/api/GitApi.ts:7371

updateThread

updateThread(
    commentThread: GitPullRequestCommentThread,
    repositoryId: string,
    pullRequestId: number,
    threadId: number,
    project?: string,
): Promise<GitPullRequestCommentThread>
Update a thread in a pull request.
Parameters
- commentThread: GitPullRequestCommentThread
  The thread content that should be updated.
- repositoryId: string
  The repository ID of the pull request's target branch.
- pullRequestId: number
  ID of the pull request.
- threadId: number
  ID of the thread to update.
- Optionalproject: string
  Project ID or project name
Returns Promise<GitPullRequestCommentThread>
Implementation of IGitApi.updateThread
- Defined in repos/azure-devops-node-api/api/GitApi.ts:6113

Class GitApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GitApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Static ReadonlyRESOURCE_AREA_ID

Methods

createAcceptHeader

Parameters

Returns string

createAnnotatedTag

Parameters

Returns Promise<GitAnnotatedTag>

createAttachment

Parameters

Returns Promise<Attachment>

createCherryPick

Parameters

Returns Promise<GitCherryPick>

createComment

Parameters

Returns Promise<Comment>

createCommitStatus

Parameters

Returns Promise<GitStatus>

createFavorite

Parameters

Returns Promise<GitRefFavorite>

createForkSyncRequest

Parameters

Returns Promise<GitForkSyncRequest>

createImportRequest

Parameters

Returns Promise<GitImportRequest>

createLike

Parameters

Returns Promise<void>

createMergeRequest

Parameters

Returns Promise<GitMerge>

createPullRequest

Parameters

Returns Promise<GitPullRequest>

createPullRequestIterationStatus

Parameters

Returns Promise<GitPullRequestStatus>

createPullRequestLabel

Parameters

Returns Promise<WebApiTagDefinition>

createPullRequestReviewer

Parameters

Returns Promise<IdentityRefWithVote>

createPullRequestReviewers

Parameters

Returns Promise<IdentityRefWithVote[]>

createPullRequestStatus

Parameters

Returns Promise<GitPullRequestStatus>

createPush

Parameters

Returns Promise<GitPush>

createRepository

Parameters

Returns Promise<GitRepository>

createRequestOptions

Parameters

Returns IRequestOptions

createRevert

`Static` `Readonly`RESOURCE_AREA_ID