GitRestClient class

Referentie

Pakket:: azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's

Uitbreiding: RestClientBase

Constructors

GitRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

createAnnotatedTag(GitAnnotatedTag, string, string)	Maak een geannoteerde tag.
createAttachment(any, string, string, number, string)	Voeg een nieuw bestand toe aan een pull-aanvraag.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Cherry kiest een specifieke doorvoer of doorvoeringen die zijn gekoppeld aan een pull-aanvraag in een nieuwe vertakking.
createComment(Comment, string, number, number, string)	Maak een opmerking over een specifieke thread in een pull-aanvraag (maximaal 500 opmerkingen kunnen per thread worden gemaakt).
createCommitStatus(GitStatus, string, string, string)	Maak de Git-doorvoerstatus.
createFavorite(GitRefFavorite, string)	Hiermee maakt u een verwijzingsfavoriet
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Vraag of de refs van een andere opslagplaats in deze worden opgehaald. Er worden twee bestaande forks gesynchroniseerd. Als u een fork wilt maken, raadpleegt u de <een href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" eindpunt voor> opslagplaatsen</a>
createImportRequest(GitImportRequest, string, string)	Maak een importaanvraag.
createLike(string, number, number, number, string)	Voeg een like toe aan een opmerking.
createMergeRequest(GitMergeParameters, string, string, boolean)	Een git-samenvoegbewerking aanvragen. Momenteel ondersteunen we het samenvoegen van slechts 2 doorvoeringen.
createPullRequest(GitPullRequest, string, string, boolean)	Maak een pull-aanvraag.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Maak een status van een pull-aanvraag voor de iteratie. Deze bewerking heeft hetzelfde resultaat als De status Maken voor een pull-aanvraag met de opgegeven iteratie-id in de aanvraagbody.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Maak een tag (als dat nog niet bestaat) en voeg deze toe als label (tag) voor een opgegeven pull-aanvraag. Het enige vereiste veld is de naam van het nieuwe label (tag).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Voeg een revisor toe aan een pull-aanvraag of cast een stem.
createPullRequestReviewers(IdentityRef[], string, number, string)	Revisoren toevoegen aan een pull-aanvraag.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Maak een status van een pull-aanvraag.
createPush(GitPush, string, string)	Push wijzigingen naar de opslagplaats.
createRepository(GitRepositoryCreateOptions, string, string)	Maak een Git-opslagplaats in een teamproject.
createRevert(GitAsyncRefOperationParameters, string, string)	Start de bewerking om een nieuwe vertakking te maken die wijzigingen terugdraait die zijn geïntroduceerd door een specifieke doorvoer of doorvoeringen die zijn gekoppeld aan een pull-aanvraag.
createThread(GitPullRequestCommentThread, string, number, string)	Maak een thread in een pull-aanvraag.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Voeg een niet-gerealiseerde identiteit toe aan de revisoren van een pull-aanvraag.
deleteAttachment(string, string, number, string)	Een bijlage bij een pull-aanvraag verwijderen.
deleteComment(string, number, number, number, string)	Verwijder een opmerking die is gekoppeld aan een specifieke thread in een pull-aanvraag.
deleteEnablementStatus(boolean, boolean, string[])	DELETE verwijdert de enablementstatus en BillableCommitters-gegevens uit DB. Als u de activeringsgegevens verwijdert, worden deze effectief uitgeschakeld voor de betrokken opslagplaatsen.
deleteLike(string, number, number, number, string)	Verwijder een like op een opmerking.
deletePullRequestIterationStatus(string, number, number, number, string)	Verwijder de iteratiestatus van pull-aanvragen.
deletePullRequestLabels(string, number, string, string, string)	Hiermee verwijdert u een label (tag) uit de set die is toegewezen aan de pull-aanvraag. De tag zelf wordt niet verwijderd.
deletePullRequestReviewer(string, number, string, string)	Een revisor verwijderen uit een pull-aanvraag.
deletePullRequestStatus(string, number, number, string)	Verwijder de status van de pull-aanvraag.
deleteRefFavorite(string, number)	Hiermee verwijdert u de opgegeven verwijzingsfavorieten
deleteRepository(string, string)	Een Git-opslagplaats verwijderen
deleteRepositoryFromRecycleBin(string, string)	Vernietig (hard verwijderen) een voorlopig verwijderde Git-opslagplaats.
getAnnotatedTag(string, string, string)	Get annotated tag.
getAttachmentContent(string, string, number, string)	Haal de bestandsinhoud van een pull-aanvraagbijlage op.
getAttachments(string, number, string)	Haal een lijst op met bestanden die zijn gekoppeld aan een bepaalde pull-aanvraag.
getAttachmentZip(string, string, number, string)	Haal de bestandsinhoud van een pull-aanvraagbijlage op.
getBillableCommitters(string, Date, number, number)	Haal de werkelijke factureerbare doorvoerers op voor de Advanced Security-service voor een bepaalde datum.
getBillableCommittersDetail(string, string, Date)	Haal gedetailleerde factureerbare doorvoerers op voor advanced security-service voor een bepaalde datum. Met gedetailleerde resultaten worden voorlopig verwijderde projecten en opslagplaatsen niet gefilterd om factureringsproblemen vast te stellen.
getBlob(string, string, string, boolean, string, boolean)	Eén blob ophalen.
getBlobContent(string, string, string, boolean, string, boolean)	Eén blob ophalen.
getBlobsZip(string[], string, string, string)	Hiermee haalt u een of meer blobs op in een zip-bestand downloaden.
getBlobZip(string, string, string, boolean, string, boolean)	Eén blob ophalen.
getBranch(string, string, string, GitVersionDescriptor)	Statistieken over één vertakking ophalen.
getBranches(string, string, GitVersionDescriptor)	Statistieken ophalen over alle vertakkingen in een opslagplaats.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Statistieken ophalen voor meerdere doorvoeringen
getChanges(string, string, string, number, number)	Wijzigingen voor een bepaalde doorvoering ophalen.
getCherryPick(string, number, string)	Informatie ophalen over een kersenkiesbewerking op basis van cherry pick Id.
getCherryPickConflict(string, number, number, string)	Eén conflict voor een kersenkies ophalen op id
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Alle conflicten voor een kersenkie ophalen
getCherryPickForRefName(string, string, string)	Informatie ophalen over een kersenkiesbewerking voor een specifieke vertakking. Deze bewerking is duur vanwege de onderliggende objectstructuur, dus deze API kijkt alleen naar de 1000 meest recente kersenkiesbewerkingen.
getCherryPickRelationships(string, string, string, boolean)	Met een commitId retourneert u een lijst met doorvoeringen die zich in dezelfde familie van kersenkiezer bevinden.
getComment(string, number, number, number, string)	Haal een opmerking op die is gekoppeld aan een specifieke thread in een pull-aanvraag.
getComments(string, number, number, string)	Alle opmerkingen ophalen die zijn gekoppeld aan een specifieke thread in een pull-aanvraag.
getCommit(string, string, string, number)	Een bepaalde doorvoering ophalen.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Zoek de dichtstbijzijnde algemene doorvoering (de samenvoegbasis) tussen basis- en doeldoorvoeringen en haal het verschil op tussen de basis- en doeldoorvoeringen of algemene en doeldoorvoeringen.
getCommits(string, GitQueryCommitsCriteria, string)	Git-doorvoeringen voor een project ophalen
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Git-doorvoeringen ophalen voor een project dat overeenkomt met de zoekcriteria
getDeletedRepositories(string)	Verwijderde Git-opslagplaatsen ophalen.
getEnablementStatus(string[], Date, number, number)	Get Enablement status for project's repositorys.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Ontvang geschatte factureerbare doorvoerers voor een opslagplaats voor de afgelopen 90 dagen.
getEstimatedBillablePushersOrg()	Ontvang geschatte factureerbare pushers voor een organisatie voor de afgelopen 90 dagen.
getEstimatedBillablePushersProject(string)	Ontvang geschatte factureerbare pushers voor een project voor de afgelopen 90 dagen.
getFileDiffs(FileDiffsCriteria, string, string)	De bestandsverschilen voor elk van de opgegeven bestanden ophalen
getForks(string, string, string, boolean)	Haal alle forks van een opslagplaats in de verzameling op.
getForkSyncRequest(string, number, string, boolean)	De details van een specifieke vorksynchronisatiebewerking ophalen.
getForkSyncRequests(string, string, boolean, boolean)	Haal alle aangevraagde forksynchronisatiebewerkingen op in deze opslagplaats.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Metagegevens en/of inhoud van items ophalen voor een verzameling items. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als download.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.
getImportRequest(string, string, number)	Een bepaalde importaanvraag ophalen.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Metagegevens en/of inhoud van items ophalen voor een verzameling items. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als download.
getItemsBatch(GitItemRequestData, string, string)	Posten voor het ophalen van een batch uit een reeks items in een opslagplaats/project op basis van een lijst met paden of een lang pad
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.
getLikes(string, number, number, number, string)	Vind ik leuk voor een opmerking.
getMergeBases(string, string, string, string, string, string)	Zoek de samenvoegbases van twee doorvoeringen, optioneel tussen vorken. Als andereRepositoryId niet is opgegeven, worden de samenvoegbasissen alleen berekend binnen de context van de lokale repositoryNameOrId.
getMergeRequest(string, string, number, boolean)	De details van een specifieke samenvoegbewerking ophalen.
getPermission(string, string, string)	Status geavanceerde beveiligingsmachtiging ophalen.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Haal een pull-aanvraag op.
getPullRequestById(number, string)	Haal een pull-aanvraag op.
getPullRequestCommits(string, number, string)	Haal de doorvoeringen voor de opgegeven pull-aanvraag op.
getPullRequestConflict(string, number, number, string)	Eén conflict voor een pull-aanvraag ophalen op basis van id
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Alle conflicten voor een pull-aanvraag ophalen
getPullRequestIteration(string, number, number, string)	Haal de opgegeven iteratie voor een pull-aanvraag op.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Haal de wijzigingen op die zijn aangebracht in een pull-aanvraag tussen twee iteraties.
getPullRequestIterationCommits(string, number, number, string, number, number)	Haal de doorvoeringen op voor de opgegeven iteratie van een pull-aanvraag.
getPullRequestIterations(string, number, string, boolean)	Haal de lijst met iteraties voor de opgegeven pull-aanvraag op.
getPullRequestIterationStatus(string, number, number, number, string)	Haal de specifieke iteratiestatus van de pull-aanvraag op op id. De status-id is uniek binnen de pull-aanvraag voor alle iteraties.
getPullRequestIterationStatuses(string, number, number, string)	Haal alle statussen op die zijn gekoppeld aan een iteratie van een pull-aanvraag.
getPullRequestLabel(string, number, string, string, string)	Hiermee haalt u één label (tag) op dat is toegewezen aan een pull-aanvraag.
getPullRequestLabels(string, number, string, string)	Haal alle labels (tags) op die zijn toegewezen aan een pull-aanvraag.
getPullRequestProperties(string, number, string)	Externe eigenschappen van de pull-aanvraag ophalen.
getPullRequestQuery(GitPullRequestQuery, string, string)	Deze API wordt gebruikt om te achterhalen welke pull-aanvragen betrekking hebben op een bepaalde doorvoer. Het kan worden gebruikt om de pull-aanvraag te vinden die een bepaalde samenvoegingsdoorvoering heeft gemaakt of kan worden gebruikt om alle pull-aanvragen te vinden die ooit een bepaalde doorvoer hebben samengevoegd. De invoer is een lijst met query's die elk een lijst met doorvoeringen bevatten. Voor elke doorvoering waarmee u zoekt, krijgt u een woordenlijst met doorvoerbewerkingen terug,> pull-aanvragen.
getPullRequestReviewer(string, number, string, string)	Informatie ophalen over een bepaalde revisor in een pull-aanvraag
getPullRequestReviewers(string, number, string)	De revisoren voor een pull-aanvraag ophalen
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Haal alle pull-aanvragen op die voldoen aan een opgegeven criteria.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Haal alle pull-aanvragen op die voldoen aan een opgegeven criteria.
getPullRequestStatus(string, number, number, string)	Haal de specifieke status van de pull-aanvraag op id op. De status-id is uniek binnen de pull-aanvraag voor alle iteraties.
getPullRequestStatuses(string, number, string)	Haal alle statussen op die zijn gekoppeld aan een pull-aanvraag.
getPullRequestThread(string, number, number, string, number, number)	Haal een thread op in een pull-aanvraag.
getPullRequestWorkItemRefs(string, number, string)	Haal een lijst met werkitems op die zijn gekoppeld aan een pull-aanvraag.
getPush(string, number, string, number, boolean)	Hiermee haalt u een bepaalde push op.
getPushCommits(string, number, string, number, number, boolean)	Haal een lijst met doorvoeringen op die zijn gekoppeld aan een bepaalde push.
getPushes(string, string, number, number, GitPushSearchCriteria)	Hiermee worden pushes opgehaald die zijn gekoppeld aan de opgegeven opslagplaats.
getRecycleBinRepositories(string)	Haal voorlopig verwijderde Git-opslagplaatsen op uit de Prullenbak.
getRefFavorite(string, number)	Hiermee haalt u de refs favoriet op voor een favoriete id.
getRefFavorites(string, string, string)	Haalt de refs-favorieten op voor een opslagplaats en een identiteit.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Voert een query uit op de opgegeven opslagplaats voor de bijbehorende refs en retourneert deze.
getRepositories(string, boolean, boolean, boolean)	Git-opslagplaatsen ophalen.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Git-opslagplaatsen ophalen met filteren op naam en paginering.
getRepository(string, string)	Haal een Git-opslagplaats op.
getRepositoryWithParent(string, boolean, string)	Haal een Git-opslagplaats op.
getRevert(string, number, string)	Informatie over een herstelbewerking ophalen door de id te herstellen.
getRevertConflict(string, number, number, string)	Eén conflict voor een terugdraaien per id ophalen
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Alle conflicten voor een terugdraaiing ophalen
getRevertForRefName(string, string, string)	Informatie ophalen over een herstelbewerking voor een specifieke vertakking.
getStatuses(string, string, string, number, number, boolean)	Statussen ophalen die zijn gekoppeld aan de Git-doorvoer.
getSuggestions(string, string, boolean)	Haal een suggestie voor een pull-aanvraag op voor een bepaalde opslagplaats of een teamproject.
getThreads(string, number, string, number, number)	Alle threads in een pull-aanvraag ophalen.
getTree(string, string, string, string, boolean, string)	Het tree-eindpunt retourneert de verzameling objecten onder de opgegeven structuur. Bomen zijn mappen in een Git-opslagplaats.
getTreeZip(string, string, string, string, boolean, string)	Het tree-eindpunt retourneert de verzameling objecten onder de opgegeven structuur. Bomen zijn mappen in een Git-opslagplaats.
queryImportRequests(string, string, boolean)	Importeeraanvragen voor een opslagplaats ophalen.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Een voorlopig verwijderde Git-opslagplaats herstellen. Onlangs verwijderde opslagplaatsen krijgen een status voor voorlopig verwijderen voordat ze hard worden verwijderd en kunnen ze niet meer worden hersteld.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Een e-mailmelding over een specifieke pull-aanvraag verzenden naar een set geadresseerden
updateCherryPickConflict(GitConflict, string, number, number, string)	Samenvoegingsconflictoplossing bijwerken
updateCherryPickConflicts(GitConflict[], string, number, string)	Meerdere oplossingen voor samenvoegingsconflicten bijwerken
updateComment(Comment, string, number, number, number, string)	Werk een opmerking bij die is gekoppeld aan een specifieke thread in een pull-aanvraag.
updateEnablementStatus(AdvSecEnablementUpdate[])	POST-activeringsstatus voor opslagplaatsen.
updateImportRequest(GitImportRequest, string, string, number)	Een mislukte importaanvraag opnieuw proberen of afbreken.
updatePullRequest(GitPullRequest, string, number, string)	Een pull-aanvraag bijwerken
updatePullRequestConflict(GitConflict, string, number, number, string)	Samenvoegingsconflictoplossing bijwerken
updatePullRequestConflicts(GitConflict[], string, number, string)	Meerdere oplossingen voor samenvoegingsconflicten bijwerken
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Verzameling iteratiestatussen voor pull-aanvragen bijwerken. Het enige ondersteunde bewerkingstype is `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Externe eigenschappen voor pull-aanvragen maken of bijwerken. De patchbewerking kan worden `add`, `replace` of `remove`. Voor `add` bewerking kan het pad leeg zijn. Als het pad leeg is, moet de waarde een lijst met sleutel-waardeparen zijn. Voor `replace` bewerking mag het pad niet leeg zijn. Als het pad niet bestaat, wordt de eigenschap toegevoegd aan de verzameling. Voor `remove` bewerking mag het pad niet leeg zijn. Als het pad niet bestaat, wordt er geen actie uitgevoerd.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Bewerk een revisorvermelding. Deze velden zijn patchable: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Stel de stemmen van meerdere revisoren opnieuw in voor een pull-aanvraag. OPMERKING: Dit eindpunt ondersteunt alleen het bijwerken van stemmen, maar biedt geen ondersteuning voor het bijwerken van vereiste revisoren (beleid gebruiken) of weergavenamen.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Verzameling pull-aanvraagstatussen bijwerken. Het enige ondersteunde bewerkingstype is `remove`.
updateRef(GitRefUpdate, string, string, string, string)	Een vertakking vergrendelen of ontgrendelen.
updateRefs(GitRefUpdate[], string, string, string)	Refs(vertakkingen) maken, bijwerken of verwijderen.
updateRepository(GitRepository, string, string)	Hiermee werkt u de Git-opslagplaats bij met een nieuwe opslagplaatsnaam of een nieuwe standaardvertakking.
updateRevertConflict(GitConflict, string, number, number, string)	Samenvoegingsconflictoplossing bijwerken
updateRevertConflicts(GitConflict[], string, number, string)	Meerdere oplossingen voor samenvoegingsconflicten bijwerken
updateThread(GitPullRequestCommentThread, string, number, number, string)	Een thread in een pull-aanvraag bijwerken.

Constructordetails

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Parameters

options: IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

createAnnotatedTag(GitAnnotatedTag, string, string)

Maak een geannoteerde tag.

function createAnnotatedTag(tagObject: GitAnnotatedTag, project: string, repositoryId: string): Promise<GitAnnotatedTag>

Parameters

tagObject: GitAnnotatedTag

Object met details van de tag die moet worden gemaakt.

project: string

Project-id of projectnaam

repositoryId: string

Id of naam van de opslagplaats.

Retouren

Promise<GitAnnotatedTag>

createAttachment(any, string, string, number, string)

Voeg een nieuw bestand toe aan een pull-aanvraag.

function createAttachment(content: any, fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment>

Parameters

content: any

Te uploaden inhoud

fileName: string

De naam van het bestand.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Cherry kiest een specifieke doorvoer of doorvoeringen die zijn gekoppeld aan een pull-aanvraag in een nieuwe vertakking.

function createCherryPick(cherryPickToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitCherryPick>

Parameters

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

Project-id of projectnaam

repositoryId: string

Id van de opslagplaats.

Retouren

Promise<GitCherryPick>

createComment(Comment, string, number, number, string)

Maak een opmerking over een specifieke thread in een pull-aanvraag (maximaal 500 opmerkingen kunnen per thread worden gemaakt).

function createComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment>

Parameters

comment: Comment

De opmerking die moet worden gemaakt. Opmerkingen kunnen maximaal 150.000 tekens zijn.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

Id van de thread waarin de gewenste opmerking zich bevindt.

project: string

Project-id of projectnaam

Retouren

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Maak de Git-doorvoerstatus.

function createCommitStatus(gitCommitStatusToCreate: GitStatus, commitId: string, repositoryId: string, project?: string): Promise<GitStatus>

Parameters

gitCommitStatusToCreate: GitStatus

Git doorvoerstatusobject dat moet worden gemaakt.

commitId: string

Id van de Git-doorvoer.

repositoryId: string

Id van de opslagplaats.

project: string

Project-id of projectnaam

Retouren

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Hiermee maakt u een verwijzingsfavoriet

function createFavorite(favorite: GitRefFavorite, project: string): Promise<GitRefFavorite>

Parameters

favorite: GitRefFavorite

De ref favoriet die u wilt maken.

project: string

Project-id of projectnaam

Retouren

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Vraag of de refs van een andere opslagplaats in deze worden opgehaald. Er worden twee bestaande forks gesynchroniseerd. Als u een fork wilt maken, raadpleegt u de <een href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" eindpunt voor> opslagplaatsen</a>

function createForkSyncRequest(syncParams: GitForkSyncRequestParameters, repositoryNameOrId: string, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

Parameters

syncParams: GitForkSyncRequestParameters

Bronopslagplaats en verw-toewijzing.

repositoryNameOrId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

includeLinks: boolean

Waar voor het opnemen van koppelingen

Retouren

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Maak een importaanvraag.

function createImportRequest(importRequest: GitImportRequest, project: string, repositoryId: string): Promise<GitImportRequest>

Parameters

importRequest: GitImportRequest

De importaanvraag die moet worden gemaakt.

project: string

Project-id of projectnaam

repositoryId: string

De naam of id van de opslagplaats.

Retouren

Promise<GitImportRequest>

createLike(string, number, number, number, string)

Voeg een like toe aan een opmerking.

function createLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

De id van de thread die de opmerking bevat.

commentId: number

De id van de opmerking.

project: string

Project-id of projectnaam

Retouren

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Een git-samenvoegbewerking aanvragen. Momenteel ondersteunen we het samenvoegen van slechts 2 doorvoeringen.

function createMergeRequest(mergeParameters: GitMergeParameters, project: string, repositoryNameOrId: string, includeLinks?: boolean): Promise<GitMerge>

Parameters

mergeParameters: GitMergeParameters

Ouders commitIds en samenvoegen doorvoeren puinhoop.

project: string

Project-id of projectnaam

repositoryNameOrId: string

De naam of id van de opslagplaats.

includeLinks: boolean

Waar voor het opnemen van koppelingen

Retouren

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Maak een pull-aanvraag.

function createPullRequest(gitPullRequestToCreate: GitPullRequest, repositoryId: string, project?: string, supportsIterations?: boolean): Promise<GitPullRequest>

Parameters

gitPullRequestToCreate: GitPullRequest

De pull-aanvraag die moet worden gemaakt.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

project: string

Project-id of projectnaam

supportsIterations: boolean

Indien waar, worden volgende pushes naar de pull-aanvraag afzonderlijk beoordeeld. Stel deze optie in op false voor grote pull-aanvragen om prestatieredenen als deze functionaliteit niet nodig is.

Retouren

Promise<GitPullRequest>

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

Maak een status van een pull-aanvraag voor de iteratie. Deze bewerking heeft hetzelfde resultaat als De status Maken voor een pull-aanvraag met de opgegeven iteratie-id in de aanvraagbody.

function createPullRequestIterationStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus>

Parameters

status: GitPullRequestStatus

Status van pull-aanvraag om te maken.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

iterationId: number

Id van de iteratie van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestStatus>

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

Maak een tag (als dat nog niet bestaat) en voeg deze toe als label (tag) voor een opgegeven pull-aanvraag. Het enige vereiste veld is de naam van het nieuwe label (tag).

function createPullRequestLabel(label: WebApiCreateTagRequestData, repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition>

Parameters

label: WebApiCreateTagRequestData

Label om toe te wijzen aan de pull-aanvraag.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

projectId: string

Project-id of projectnaam.

Retouren

Promise<WebApiTagDefinition>

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

Voeg een revisor toe aan een pull-aanvraag of cast een stem.

function createPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Parameters

reviewer: IdentityRefWithVote

Revisor stemt.<br/>Als de revisor-id hier is opgenomen, moet deze overeenkomen met de parameter reviewerID.<br/>Revisoren kunnen hun eigen stem instellen met deze methode. Wanneer u andere revisoren toevoegt, moet stem worden ingesteld op nul.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

reviewerId: string

Id van de revisor.

project: string

Project-id of projectnaam

Retouren

Promise<IdentityRefWithVote>

createPullRequestReviewers(IdentityRef[], string, number, string)

Revisoren toevoegen aan een pull-aanvraag.

function createPullRequestReviewers(reviewers: IdentityRef[], repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

Parameters

reviewers: IdentityRef[]

Revisoren die moeten worden toegevoegd aan de pull-aanvraag.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Maak een status van een pull-aanvraag.

function createPullRequestStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus>

Parameters

status: GitPullRequestStatus

Status van pull-aanvraag om te maken.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Push wijzigingen naar de opslagplaats.

function createPush(push: GitPush, repositoryId: string, project?: string): Promise<GitPush>

Parameters

push: GitPush

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

Retouren

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Maak een Git-opslagplaats in een teamproject.

function createRepository(gitRepositoryToCreate: GitRepositoryCreateOptions, project?: string, sourceRef?: string): Promise<GitRepository>

Parameters

gitRepositoryToCreate: GitRepositoryCreateOptions

Geef de naam van de opslagplaats, het teamproject en/of de bovenliggende opslagplaats op. Teamprojectgegevens kunnen worden weggelaten uit gitRepositoryToCreate als de aanvraag projectbereik heeft (bijvoorbeeld project-id).

project: string

Project-id of projectnaam

sourceRef: string

[optioneel] Geef de bronverwijzing op die moet worden gebruikt tijdens het maken van een fork-opslagplaats

Retouren

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Start de bewerking om een nieuwe vertakking te maken die wijzigingen terugdraait die zijn geïntroduceerd door een specifieke doorvoer of doorvoeringen die zijn gekoppeld aan een pull-aanvraag.

function createRevert(revertToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitRevert>

Parameters

revertToCreate: GitAsyncRefOperationParameters

project: string

Project-id of projectnaam

repositoryId: string

Id van de opslagplaats.

Retouren

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Maak een thread in een pull-aanvraag.

function createThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestCommentThread>

Parameters

commentThread: GitPullRequestCommentThread

De thread die moet worden gemaakt. Thread moet ten minste één opmerking bevatten.

repositoryId: string

Opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Voeg een niet-gerealiseerde identiteit toe aan de revisoren van een pull-aanvraag.

function createUnmaterializedPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote>

Parameters

reviewer: IdentityRefWithVote

Revisor die moet worden toegevoegd aan de pull-aanvraag.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Een bijlage bij een pull-aanvraag verwijderen.

function deleteAttachment(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Parameters

fileName: string

De naam van de bijlage die u wilt verwijderen.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<void>

deleteComment(string, number, number, number, string)

Verwijder een opmerking die is gekoppeld aan een specifieke thread in een pull-aanvraag.

function deleteComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

Id van de thread waarin de gewenste opmerking zich bevindt.

commentId: number

Id van de opmerking.

project: string

Project-id of projectnaam

Retouren

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE verwijdert de enablementstatus en BillableCommitters-gegevens uit DB. Als u de activeringsgegevens verwijdert, worden deze effectief uitgeschakeld voor de betrokken opslagplaatsen.

function deleteEnablementStatus(allProjects: boolean, includeBillableCommitters?: boolean, projectIds?: string[]): Promise<void>

Parameters

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Retouren

Promise<void>

deleteLike(string, number, number, number, string)

Verwijder een like op een opmerking.

function deleteLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

De id van de thread die de opmerking bevat.

commentId: number

De id van de opmerking.

project: string

Project-id of projectnaam

Retouren

Promise<void>

deletePullRequestIterationStatus(string, number, number, number, string)

Verwijder de iteratiestatus van pull-aanvragen.

function deletePullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<void>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

iterationId: number

Id van de iteratie van de pull-aanvraag.

statusId: number

Id van de status van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<void>

deletePullRequestLabels(string, number, string, string, string)

Hiermee verwijdert u een label (tag) uit de set die is toegewezen aan de pull-aanvraag. De tag zelf wordt niet verwijderd.

function deletePullRequestLabels(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<void>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

labelIdOrName: string

De naam of id van het aangevraagde label.

project: string

Project-id of projectnaam

projectId: string

Project-id of projectnaam.

Retouren

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Een revisor verwijderen uit een pull-aanvraag.

function deletePullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<void>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

reviewerId: string

Id van de revisor die moet worden verwijderd.

project: string

Project-id of projectnaam

Retouren

Promise<void>

deletePullRequestStatus(string, number, number, string)

Verwijder de status van de pull-aanvraag.

function deletePullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<void>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

statusId: number

Id van de status van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<void>

deleteRefFavorite(string, number)

Hiermee verwijdert u de opgegeven verwijzingsfavorieten

function deleteRefFavorite(project: string, favoriteId: number): Promise<void>

Parameters

project: string

Project-id of projectnaam

favoriteId: number

De id van de verwijzingsfavoriet die u wilt verwijderen.

Retouren

Promise<void>

deleteRepository(string, string)

Een Git-opslagplaats verwijderen

function deleteRepository(repositoryId: string, project?: string): Promise<void>

Parameters

repositoryId: string

De id van de opslagplaats.

project: string

Project-id of projectnaam

Retouren

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Vernietig (hard verwijderen) een voorlopig verwijderde Git-opslagplaats.

function deleteRepositoryFromRecycleBin(project: string, repositoryId: string): Promise<void>

Parameters

project: string

Project-id of projectnaam

repositoryId: string

De id van de opslagplaats.

Retouren

Promise<void>

getAnnotatedTag(string, string, string)

Get annotated tag.

function getAnnotatedTag(project: string, repositoryId: string, objectId: string): Promise<GitAnnotatedTag>

Parameters

project: string

Project-id of projectnaam

repositoryId: string

Id of naam van de opslagplaats.

objectId: string

ObjectId (Sha1Id) van de tag die moet worden opgehaald.

Retouren

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Haal de bestandsinhoud van een pull-aanvraagbijlage op.

function getAttachmentContent(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

Parameters

fileName: string

De naam van de bijlage.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<ArrayBuffer>

getAttachments(string, number, string)

Haal een lijst op met bestanden die zijn gekoppeld aan een bepaalde pull-aanvraag.

function getAttachments(repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Haal de bestandsinhoud van een pull-aanvraagbijlage op.

function getAttachmentZip(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

Parameters

fileName: string

De naam van de bijlage.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Haal de werkelijke factureerbare doorvoerers op voor de Advanced Security-service voor een bepaalde datum.

function getBillableCommitters(project: string, billingDate?: Date, skip?: number, take?: number): Promise<BillableCommitter[]>

Parameters

project: string

Project-id of projectnaam

billingDate: Date

UTC verwacht. Als er geen standaardwaarden zijn opgegeven voor de vorige factureringsdag.

skip: number

Sla X rijen met resultatenset over om paginering te simuleren.

take: number

Retourneer Y-rijen met resultatenset om paging te simuleren.

Retouren

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Haal gedetailleerde factureerbare doorvoerers op voor advanced security-service voor een bepaalde datum. Met gedetailleerde resultaten worden voorlopig verwijderde projecten en opslagplaatsen niet gefilterd om factureringsproblemen vast te stellen.

function getBillableCommittersDetail(project: string, includeDetails: string, billingDate?: Date): Promise<BillableCommitterDetail[]>

Parameters

project: string

Project-id of projectnaam

includeDetails: string

Alle details van de factureerbare committers retourneren.

billingDate: Date

UTC verwacht. Als er geen standaardwaarden zijn opgegeven voor de vorige factureringsdag.

Retouren

Promise<BillableCommitterDetail[]>

getBlob(string, string, string, boolean, string, boolean)

Eén blob ophalen.

function getBlob(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<GitBlobRef>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

sha1: string

SHA1-hash van het bestand. U kunt de SHA1 van een bestand ophalen met behulp van het eindpunt 'Git/Items/Item ophalen'.

project: string

Project-id of projectnaam

download: boolean

Als dit het geval is, vraagt u om een download in plaats van in een browser. Opmerking: deze waarde wordt standaard ingesteld op true als $format zip is

fileName: string

Geef een fileName op die moet worden gebruikt voor een download.

resolveLfs: boolean

Als dit waar is, probeert u een blob op te lossen in de LFS-inhoud, als het een LFS-aanwijzerbestand is. Alleen compatibel met octet-stream headers of $format typen accepteren

Retouren

Promise<GitBlobRef>

getBlobContent(string, string, string, boolean, string, boolean)

Eén blob ophalen.

function getBlobContent(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

sha1: string

SHA1-hash van het bestand. U kunt de SHA1 van een bestand ophalen met behulp van het eindpunt 'Git/Items/Item ophalen'.

project: string

Project-id of projectnaam

download: boolean

Als dit het geval is, vraagt u om een download in plaats van in een browser. Opmerking: deze waarde wordt standaard ingesteld op true als $format zip is

fileName: string

Geef een fileName op die moet worden gebruikt voor een download.

resolveLfs: boolean

Als dit waar is, probeert u een blob op te lossen in de LFS-inhoud, als het een LFS-aanwijzerbestand is. Alleen compatibel met octet-stream headers of $format typen accepteren

Retouren

Promise<ArrayBuffer>

getBlobsZip(string[], string, string, string)

Hiermee haalt u een of meer blobs op in een zip-bestand downloaden.

function getBlobsZip(blobIds: string[], repositoryId: string, project?: string, filename?: string): Promise<ArrayBuffer>

Parameters

blobIds: string[]

Blob-id's (SHA1 hashes) die moeten worden geretourneerd in het zip-bestand.

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

filename: string

Retouren

Promise<ArrayBuffer>

getBlobZip(string, string, string, boolean, string, boolean)

Eén blob ophalen.

function getBlobZip(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

sha1: string

SHA1-hash van het bestand. U kunt de SHA1 van een bestand ophalen met behulp van het eindpunt 'Git/Items/Item ophalen'.

project: string

Project-id of projectnaam

download: boolean

Als dit het geval is, vraagt u om een download in plaats van in een browser. Opmerking: deze waarde wordt standaard ingesteld op true als $format zip is

fileName: string

Geef een fileName op die moet worden gebruikt voor een download.

resolveLfs: boolean

Als dit waar is, probeert u een blob op te lossen in de LFS-inhoud, als het een LFS-aanwijzerbestand is. Alleen compatibel met octet-stream headers of $format typen accepteren

Retouren

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Statistieken over één vertakking ophalen.

function getBranch(repositoryId: string, name: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

name: string

Naam van de vertakking.

project: string

Project-id of projectnaam

baseVersionDescriptor: GitVersionDescriptor

Identificeert de doorvoer of vertakking die moet worden gebruikt als basis.

Retouren

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Statistieken ophalen over alle vertakkingen in een opslagplaats.

function getBranches(repositoryId: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats[]>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

baseVersionDescriptor: GitVersionDescriptor

Identificeert de doorvoer of vertakking die moet worden gebruikt als basis.

Retouren

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Statistieken ophalen voor meerdere doorvoeringen

function getBranchStatsBatch(searchCriteria: GitQueryBranchStatsCriteria, repositoryId: string, project?: string): Promise<GitBranchStats[]>

Parameters

searchCriteria: GitQueryBranchStatsCriteria

Basisdoorvoering en lijst met doeldoorvoeringen om te vergelijken.

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

Retouren

Promise<GitBranchStats[]>

getChanges(string, string, string, number, number)

Wijzigingen voor een bepaalde doorvoering ophalen.

function getChanges(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number): Promise<GitCommitChanges>

Parameters

commitId: string

De id van de doorvoering.

repositoryId: string

De id of beschrijvende naam van de opslagplaats. Als u de beschrijvende naam wilt gebruiken, moet projectId ook worden opgegeven.

project: string

Project-id of projectnaam

top: number

Het maximum aantal wijzigingen dat moet worden geretourneerd.

skip: number

Het aantal wijzigingen dat moet worden overgeslagen.

Retouren

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Informatie ophalen over een kersenkiesbewerking op basis van cherry pick Id.

function getCherryPick(project: string, cherryPickId: number, repositoryId: string): Promise<GitCherryPick>

Parameters

project: string

Project-id of projectnaam

cherryPickId: number

Id van de kersenkiezer.

repositoryId: string

Id van de opslagplaats.

Retouren

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Eén conflict voor een kersenkies ophalen op id

function getCherryPickConflict(repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

Parameters

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflict>

getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)

Alle conflicten voor een kersenkie ophalen

function getCherryPickConflicts(repositoryId: string, cherryPickId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

Parameters

repositoryId: string

cherryPickId: number

project: string

Project-id of projectnaam

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Retouren

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Informatie ophalen over een kersenkiesbewerking voor een specifieke vertakking. Deze bewerking is duur vanwege de onderliggende objectstructuur, dus deze API kijkt alleen naar de 1000 meest recente kersenkiesbewerkingen.

function getCherryPickForRefName(project: string, repositoryId: string, refName: string): Promise<GitCherryPick>

Parameters

project: string

Project-id of projectnaam

repositoryId: string

Id van de opslagplaats.

refName: string

De GitAsyncRefOperationParameters generatedRefName die wordt gebruikt voor de kersenkiesbewerking.

Retouren

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Met een commitId retourneert u een lijst met doorvoeringen die zich in dezelfde familie van kersenkiezer bevinden.

function getCherryPickRelationships(repositoryNameOrId: string, commitId: string, project?: string, includeLinks?: boolean): Promise<GitCommitRef[]>

Parameters

repositoryNameOrId: string

commitId: string

project: string

Project-id of projectnaam

includeLinks: boolean

Retouren

Promise<GitCommitRef[]>

getComment(string, number, number, number, string)

Haal een opmerking op die is gekoppeld aan een specifieke thread in een pull-aanvraag.

function getComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

Id van de thread waarin de gewenste opmerking zich bevindt.

commentId: number

Id van de opmerking.

project: string

Project-id of projectnaam

Retouren

Promise<Comment>

getComments(string, number, number, string)

Alle opmerkingen ophalen die zijn gekoppeld aan een specifieke thread in een pull-aanvraag.

function getComments(repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

Id van de thread.

project: string

Project-id of projectnaam

Retouren

Promise<Comment[]>

getCommit(string, string, string, number)

Een bepaalde doorvoering ophalen.

function getCommit(commitId: string, repositoryId: string, project?: string, changeCount?: number): Promise<GitCommit>

Parameters

commitId: string

De id van de doorvoering.

repositoryId: string

De id of beschrijvende naam van de opslagplaats. Als u de beschrijvende naam wilt gebruiken, moet projectId ook worden opgegeven.

project: string

Project-id of projectnaam

changeCount: number

Het aantal wijzigingen dat moet worden opgenomen in het resultaat.

Retouren

Promise<GitCommit>

getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)

Zoek de dichtstbijzijnde algemene doorvoering (de samenvoegbasis) tussen basis- en doeldoorvoeringen en haal het verschil op tussen de basis- en doeldoorvoeringen of algemene en doeldoorvoeringen.

function getCommitDiffs(repositoryId: string, project?: string, diffCommonCommit?: boolean, top?: number, skip?: number, baseVersionDescriptor?: GitBaseVersionDescriptor, targetVersionDescriptor?: GitTargetVersionDescriptor): Promise<GitCommitDiffs>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

diffCommonCommit: boolean

Indien waar, verschillen tussen veelvoorkomende doorvoeringen en doeldoorvoeringen. Als dit onwaar is, verschillen tussen basis- en doeldoorvoeringen.

top: number

Maximum aantal wijzigingen dat moet worden geretourneerd. De standaardwaarde is 100.

skip: number

Aantal wijzigingen dat moet worden overgeslagen

baseVersionDescriptor: GitBaseVersionDescriptor

Descriptor voor basisdoorvoering.

targetVersionDescriptor: GitTargetVersionDescriptor

Descriptor voor doeldoorvoering.

Retouren

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Git-doorvoeringen voor een project ophalen

function getCommits(repositoryId: string, searchCriteria: GitQueryCommitsCriteria, project?: string): Promise<GitCommitRef[]>

Parameters

repositoryId: string

De id of beschrijvende naam van de opslagplaats. Als u de beschrijvende naam wilt gebruiken, moet projectId ook worden opgegeven.

searchCriteria: GitQueryCommitsCriteria

project: string

Project-id of projectnaam

Retouren

Promise<GitCommitRef[]>

getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)

Git-doorvoeringen ophalen voor een project dat overeenkomt met de zoekcriteria

function getCommitsBatch(searchCriteria: GitQueryCommitsCriteria, repositoryId: string, project?: string, skip?: number, top?: number, includeStatuses?: boolean): Promise<GitCommitRef[]>

Parameters

searchCriteria: GitQueryCommitsCriteria

Zoekopties

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

skip: number

Het aantal doorvoeringen dat moet worden overgeslagen. De waarde mag niet groter zijn dan 3.000.000.

top: number

Maximum aantal doorvoeringen dat moet worden geretourneerd. De waarde mag niet groter zijn dan 50.000.

includeStatuses: boolean

Waar om aanvullende doorvoerstatusgegevens op te nemen.

Retouren

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Verwijderde Git-opslagplaatsen ophalen.

function getDeletedRepositories(project: string): Promise<GitDeletedRepository[]>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<GitDeletedRepository[]>

getEnablementStatus(string[], Date, number, number)

Get Enablement status for project's repositorys.

function getEnablementStatus(projectIds?: string[], billingDate?: Date, skip?: number, take?: number): Promise<AdvSecEnablementStatus[]>

Parameters

projectIds: string[]

Null-standaardwaarden voor alle projecten in de host, lijst met opslagplaatsen van het project om te retourneren

billingDate: Date

UTC verwacht, null-standaardwaarden voor UtcNow(), kunnen worden opgegeven voor een bepaald tijdstip

skip: number

Sla X rijen met resultatenset over om paginering te simuleren.

take: number

Retourneer Y-rijen met resultatenset om paging te simuleren.

Retouren

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

function getEnableOnCreateHost(enableOnCreateHost: boolean): Promise<boolean>

Parameters

enableOnCreateHost: boolean

Retouren

Promise<boolean>

getEnableOnCreateProject(string)

function getEnableOnCreateProject(enableOnCreateProjectId: string): Promise<boolean>

Parameters

enableOnCreateProjectId: string

Retouren

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Ontvang geschatte factureerbare doorvoerers voor een opslagplaats voor de afgelopen 90 dagen.

function getEstimatedBillableCommittersRepo(project: string, repositoryId: string): Promise<BillableCommitter[]>

Parameters

project: string

Project-id of projectnaam

repositoryId: string

Retouren

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Ontvang geschatte factureerbare pushers voor een organisatie voor de afgelopen 90 dagen.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Retouren

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Ontvang geschatte factureerbare pushers voor een project voor de afgelopen 90 dagen.

function getEstimatedBillablePushersProject(project: string): Promise<BillablePusher[]>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

De bestandsverschilen voor elk van de opgegeven bestanden ophalen

function getFileDiffs(fileDiffsCriteria: FileDiffsCriteria, project: string, repositoryId: string): Promise<FileDiff[]>

Parameters

fileDiffsCriteria: FileDiffsCriteria

Lijst met bestandsparametersobjecten

project: string

Project-id of projectnaam

repositoryId: string

De naam of id van de opslagplaats

Retouren

Promise<FileDiff[]>

getForks(string, string, string, boolean)

Haal alle forks van een opslagplaats in de verzameling op.

function getForks(repositoryNameOrId: string, collectionId: string, project?: string, includeLinks?: boolean): Promise<GitRepositoryRef[]>

Parameters

repositoryNameOrId: string

De naam of id van de opslagplaats.

collectionId: string

Teamprojectverzamelings-id.

project: string

Project-id of projectnaam

includeLinks: boolean

Waar voor het opnemen van koppelingen.

Retouren

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

De details van een specifieke vorksynchronisatiebewerking ophalen.

function getForkSyncRequest(repositoryNameOrId: string, forkSyncOperationId: number, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

Parameters

repositoryNameOrId: string

De naam of id van de opslagplaats.

forkSyncOperationId: number

OperationId van de synchronisatieaanvraag.

project: string

Project-id of projectnaam

includeLinks: boolean

Waar voor het opnemen van koppelingen.

Retouren

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Haal alle aangevraagde forksynchronisatiebewerkingen op in deze opslagplaats.

function getForkSyncRequests(repositoryNameOrId: string, project?: string, includeAbandoned?: boolean, includeLinks?: boolean): Promise<GitForkSyncRequest[]>

Parameters

repositoryNameOrId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

includeAbandoned: boolean

Waar voor het opnemen van verlaten aanvragen.

includeLinks: boolean

Waar voor het opnemen van koppelingen.

Retouren

Promise<GitForkSyncRequest[]>

getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

Metagegevens en/of inhoud voor één item ophalen. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud, die altijd wordt geretourneerd als download.

function getHfsItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<GitItem>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

path: string

Het itempad.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

includeContent: boolean

Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardwaarde is onwaar.

resolveHfs: boolean

Ingesteld op true om Git HFS-aanwijzerbestanden om te zetten om werkelijke inhoud van Git HFS te retourneren. De standaardwaarde is waar.

sanitize: boolean

Ingesteld op True om een svg-bestand te opschonen en als afbeelding te retourneren. Alleen nuttig als u om een svg-bestand wordt gevraagd. De standaardwaarde is onwaar.

Retouren

Promise<GitItem>

getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

path: string

Het itempad.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

includeContent: boolean

Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardwaarde is onwaar.

resolveHfs: boolean

Ingesteld op true om Git HFS-aanwijzerbestanden om te zetten om werkelijke inhoud van Git HFS te retourneren. De standaardwaarde is waar.

sanitize: boolean

Ingesteld op True om een svg-bestand te opschonen en als afbeelding te retourneren. Alleen nuttig als u om een svg-bestand wordt gevraagd. De standaardwaarde is onwaar.

Retouren

Promise<ArrayBuffer>

getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

Metagegevens en/of inhoud van items ophalen voor een verzameling items. De downloadparameter is om aan te geven of de inhoud beschikbaar moet zijn als een download of alleen als een stream in het antwoord moet worden verzonden. Dit geldt niet voor gezipte inhoud die altijd wordt geretourneerd als download.

function getHfsItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

includeLinks: boolean

Ingesteld op Waar om koppelingen naar items op te nemen. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

zipForUnix: boolean

Ingesteld op waar om de bestandsmachtigingen voor UNIX-systemen (en POSIX)-systemen, zoals uitvoerbare bestanden en symlinks, te behouden

Retouren

Promise<GitItem[]>

getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<string>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

path: string

Het itempad.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

includeContent: boolean

Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardwaarde is onwaar.

resolveHfs: boolean

Ingesteld op true om Git HFS-aanwijzerbestanden om te zetten om werkelijke inhoud van Git HFS te retourneren. De standaardwaarde is waar.

sanitize: boolean

Ingesteld op True om een svg-bestand te opschonen en als afbeelding te retourneren. Alleen nuttig als u om een svg-bestand wordt gevraagd. De standaardwaarde is onwaar.

Retouren

Promise<string>

getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

path: string

Het itempad.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

includeContent: boolean

Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardwaarde is onwaar.

resolveHfs: boolean

Ingesteld op true om Git HFS-aanwijzerbestanden om te zetten om werkelijke inhoud van Git HFS te retourneren. De standaardwaarde is waar.

sanitize: boolean

Ingesteld op True om een svg-bestand te opschonen en als afbeelding te retourneren. Alleen nuttig als u om een svg-bestand wordt gevraagd. De standaardwaarde is onwaar.

Retouren

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Een bepaalde importaanvraag ophalen.

function getImportRequest(project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

Parameters

project: string

Project-id of projectnaam

repositoryId: string

De naam of id van de opslagplaats.

importRequestId: number

De unieke id voor de importaanvraag.

Retouren

Promise<GitImportRequest>

getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function 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>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

path: string

Het itempad.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

includeContent: boolean

Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardwaarde is onwaar.

resolveLfs: boolean

Ingesteld op Waar om Git LFS-aanwijzerbestanden om te zetten om werkelijke inhoud van Git LFS te retourneren. De standaardwaarde is onwaar.

sanitize: boolean

Ingesteld op True om een svg-bestand te opschonen en als afbeelding te retourneren. Alleen nuttig als u om een svg-bestand wordt gevraagd. De standaardwaarde is onwaar.

Retouren

Promise<GitItem>

getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function 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<ArrayBuffer>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

path: string

Het itempad.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

includeContent: boolean

Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardwaarde is onwaar.

resolveLfs: boolean

Ingesteld op Waar om Git LFS-aanwijzerbestanden om te zetten om werkelijke inhoud van Git LFS te retourneren. De standaardwaarde is onwaar.

sanitize: boolean

Ingesteld op True om een svg-bestand te opschonen en als afbeelding te retourneren. Alleen nuttig als u om een svg-bestand wordt gevraagd. De standaardwaarde is onwaar.

Retouren

Promise<ArrayBuffer>

getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

function getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

includeLinks: boolean

Ingesteld op Waar om koppelingen naar items op te nemen. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

zipForUnix: boolean

Ingesteld op waar om de bestandsmachtigingen voor UNIX-systemen (en POSIX)-systemen, zoals uitvoerbare bestanden en symlinks, te behouden

Retouren

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Posten voor het ophalen van een batch uit een reeks items in een opslagplaats/project op basis van een lijst met paden of een lang pad

function getItemsBatch(requestData: GitItemRequestData, repositoryId: string, project?: string): Promise<GitItem[][]>

Parameters

requestData: GitItemRequestData

Gegevenskenmerken aanvragen: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Verzameling items die moeten worden opgehaald, inclusief pad-, versie- en recursieniveau. IncludeContentMetadata: Of metagegevens moeten worden opgenomen voor alle items LatestProcessedChange: of ondiepe verw moet worden opgenomen om door te voeren dat elk item voor het laatst is gewijzigd. IncludeLinks: Of het veld _links moet worden opgenomen in de ondiepe verwijzingen.

repositoryId: string

De naam of id van de opslagplaats

project: string

Project-id of projectnaam

Retouren

Promise<GitItem[][]>

getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function 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<string>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

path: string

Het itempad.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

includeContent: boolean

Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardwaarde is onwaar.

resolveLfs: boolean

Ingesteld op Waar om Git LFS-aanwijzerbestanden om te zetten om werkelijke inhoud van Git LFS te retourneren. De standaardwaarde is onwaar.

sanitize: boolean

Ingesteld op True om een svg-bestand te opschonen en als afbeelding te retourneren. Alleen nuttig als u om een svg-bestand wordt gevraagd. De standaardwaarde is onwaar.

Retouren

Promise<string>

getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function 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<ArrayBuffer>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

path: string

Het itempad.

project: string

Project-id of projectnaam

scopePath: string

Het padbereik. De standaardwaarde is null.

recursionLevel: VersionControlRecursionType

Het recursieniveau van deze aanvraag. De standaardwaarde is 'none', geen recursie.

includeContentMetadata: boolean

Ingesteld op waar om metagegevens van inhoud op te nemen. De standaardwaarde is onwaar.

latestProcessedChange: boolean

Ingesteld op Waar om de meest recente wijzigingen op te nemen. De standaardwaarde is onwaar.

download: boolean

Ingesteld op True om het antwoord als een bestand te downloaden. De standaardwaarde is onwaar.

versionDescriptor: GitVersionDescriptor

Versiedescriptor. De standaardbranch is de standaardbranch voor de opslagplaats.

includeContent: boolean

Ingesteld op true om iteminhoud op te nemen bij het aanvragen van json. De standaardwaarde is onwaar.

resolveLfs: boolean

Ingesteld op Waar om Git LFS-aanwijzerbestanden om te zetten om werkelijke inhoud van Git LFS te retourneren. De standaardwaarde is onwaar.

sanitize: boolean

Ingesteld op True om een svg-bestand te opschonen en als afbeelding te retourneren. Alleen nuttig als u om een svg-bestand wordt gevraagd. De standaardwaarde is onwaar.

Retouren

Promise<ArrayBuffer>

getLikes(string, number, number, number, string)

Vind ik leuk voor een opmerking.

function getLikes(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<IdentityRef[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

De id van de thread die de opmerking bevat.

commentId: number

De id van de opmerking.

project: string

Project-id of projectnaam

Retouren

Promise<IdentityRef[]>

getMergeBases(string, string, string, string, string, string)

Zoek de samenvoegbases van twee doorvoeringen, optioneel tussen vorken. Als andereRepositoryId niet is opgegeven, worden de samenvoegbasissen alleen berekend binnen de context van de lokale repositoryNameOrId.

function getMergeBases(repositoryNameOrId: string, commitId: string, otherCommitId: string, project?: string, otherCollectionId?: string, otherRepositoryId?: string): Promise<GitCommitRef[]>

Parameters

repositoryNameOrId: string

Id of naam van de lokale opslagplaats.

commitId: string

Eerst doorvoeren, meestal de tip van de doelbranch van de mogelijke samenvoeging.

otherCommitId: string

Andere doorvoer, meestal de tip van de bronbranch van de mogelijke samenvoeging.

project: string

Project-id of projectnaam

otherCollectionId: string

De verzamelings-id waar andereCommitId zich bevindt.

otherRepositoryId: string

De opslagplaats-id waar andereCommitId zich bevindt.

Retouren

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

De details van een specifieke samenvoegbewerking ophalen.

function getMergeRequest(project: string, repositoryNameOrId: string, mergeOperationId: number, includeLinks?: boolean): Promise<GitMerge>

Parameters

project: string

Project-id of projectnaam

repositoryNameOrId: string

De naam of id van de opslagplaats.

mergeOperationId: number

OperationId van de samenvoegaanvraag.

includeLinks: boolean

Waar voor het opnemen van koppelingen

Retouren

Promise<GitMerge>

getPermission(string, string, string)

Status geavanceerde beveiligingsmachtiging ophalen.

function getPermission(projectName?: string, repositoryId?: string, permission?: string): Promise<boolean>

Parameters

projectName: string

repositoryId: string

Gebruiker van de opslagplaats probeert toegang te krijgen

permission: string

De machtiging die wordt aangevraagd, moet 'viewAlert' 'dismissAlert' 'manage' 'viewEnablement' of 'repoRead' zijn

Retouren

Promise<boolean>

getPullRequest(string, number, string, number, number, number, boolean, boolean)

Haal een pull-aanvraag op.

function getPullRequest(repositoryId: string, pullRequestId: number, project?: string, maxCommentLength?: number, skip?: number, top?: number, includeCommits?: boolean, includeWorkItemRefs?: boolean): Promise<GitPullRequest>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

De id van de pull-aanvraag die moet worden opgehaald.

project: string

Project-id of projectnaam

maxCommentLength: number

Niet gebruikt.

skip: number

Niet gebruikt.

top: number

Niet gebruikt.

includeCommits: boolean

Indien waar, wordt de pull-aanvraag geretourneerd met de bijbehorende doorvoeringen.

includeWorkItemRefs: boolean

Indien waar, wordt de pull-aanvraag geretourneerd met de bijbehorende werkitemverwijzingen.

Retouren

Promise<GitPullRequest>

getPullRequestById(number, string)

Haal een pull-aanvraag op.

function getPullRequestById(pullRequestId: number, project?: string): Promise<GitPullRequest>

Parameters

pullRequestId: number

De id van de pull-aanvraag die moet worden opgehaald.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Haal de doorvoeringen voor de opgegeven pull-aanvraag op.

function getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<PagedList<GitCommitRef>>

Parameters

repositoryId: string

Id of naam van de opslagplaats.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Eén conflict voor een pull-aanvraag ophalen op basis van id

function getPullRequestConflict(repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

Parameters

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflict>

getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)

Alle conflicten voor een pull-aanvraag ophalen

function getPullRequestConflicts(repositoryId: string, pullRequestId: number, project?: string, skip?: number, top?: number, includeObsolete?: boolean, excludeResolved?: boolean, onlyResolved?: boolean): Promise<GitConflict[]>

Parameters

repositoryId: string

De opslagplaats van de pull-aanvraag.

pullRequestId: number

De id van de pull-aanvraag.

project: string

Project-id of projectnaam

skip: number

Conflicten om over te slaan.

top: number

Conflicten die moeten worden geretourneerd na het overslaan.

includeObsolete: boolean

Bevat verouderde conflicten.

excludeResolved: boolean

Sluit conflicten uit die al zijn opgelost.

onlyResolved: boolean

Retourneert alleen de conflicten die zijn opgelost.

Retouren

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Haal de opgegeven iteratie voor een pull-aanvraag op.

function getPullRequestIteration(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestIteration>

Parameters

repositoryId: string

Id of naam van de opslagplaats.

pullRequestId: number

Id van de pull-aanvraag.

iterationId: number

Id van de iteratie van de pull-aanvraag die moet worden geretourneerd.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestIteration>

getPullRequestIterationChanges(string, number, number, string, number, number, number)

Haal de wijzigingen op die zijn aangebracht in een pull-aanvraag tussen twee iteraties.

function getPullRequestIterationChanges(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number, compareTo?: number): Promise<GitPullRequestIterationChanges>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

iterationId: number

Id van de iteratie van de pull-aanvraag. <br /> Iteratie is het hoofd van de bronvertakking op het moment dat de pull-aanvraag wordt gemaakt en volgende iteraties worden gemaakt wanneer er pushs naar de bronvertakking worden gepusht. Toegestane waarden liggen tussen 1 en de maximale iteratie voor deze pull-aanvraag.

project: string

Project-id of projectnaam

top: number

Facultatief. Het aantal wijzigingen dat moet worden opgehaald. De standaardwaarde is 100 en de maximumwaarde is 2000.

skip: number

Facultatief. Het aantal te negeren wijzigingen. Als u bijvoorbeeld wijzigingen 101-150 wilt ophalen, stelt u de top 50 in en gaat u verder met 100.

compareTo: number

Id van de iteratie van de pull-aanvraag om mee te vergelijken. De standaardwaarde is nul die aangeeft dat de vergelijking wordt gemaakt op basis van de algemene doorvoering tussen de bron- en doelvertakkingen

Retouren

Promise<GitPullRequestIterationChanges>

getPullRequestIterationCommits(string, number, number, string, number, number)

Haal de doorvoeringen op voor de opgegeven iteratie van een pull-aanvraag.

function getPullRequestIterationCommits(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number): Promise<GitCommitRef[]>

Parameters

repositoryId: string

Id of naam van de opslagplaats.

pullRequestId: number

Id van de pull-aanvraag.

iterationId: number

Id van de iteratie waaruit de doorvoeringen moeten worden opgehaald.

project: string

Project-id of projectnaam

top: number

Maximum aantal doorvoeringen dat moet worden geretourneerd. Het maximum aantal doorvoeringen dat per batch kan worden geretourneerd, is 500.

skip: number

Het aantal doorvoeringen dat moet worden overgeslagen.

Retouren

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Haal de lijst met iteraties voor de opgegeven pull-aanvraag op.

function getPullRequestIterations(repositoryId: string, pullRequestId: number, project?: string, includeCommits?: boolean): Promise<GitPullRequestIteration[]>

Parameters

repositoryId: string

Id of naam van de opslagplaats.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

includeCommits: boolean

Indien waar, neemt u de doorvoeringen op die zijn gekoppeld aan elke iteratie in het antwoord.

Retouren

Promise<GitPullRequestIteration[]>

getPullRequestIterationStatus(string, number, number, number, string)

Haal de specifieke iteratiestatus van de pull-aanvraag op op id. De status-id is uniek binnen de pull-aanvraag voor alle iteraties.

function getPullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

iterationId: number

Id van de iteratie van de pull-aanvraag.

statusId: number

Id van de status van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Haal alle statussen op die zijn gekoppeld aan een iteratie van een pull-aanvraag.

function getPullRequestIterationStatuses(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

iterationId: number

Id van de iteratie van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestStatus[]>

getPullRequestLabel(string, number, string, string, string)

Hiermee haalt u één label (tag) op dat is toegewezen aan een pull-aanvraag.

function getPullRequestLabel(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<WebApiTagDefinition>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

labelIdOrName: string

De naam of id van het aangevraagde label.

project: string

Project-id of projectnaam

projectId: string

Project-id of projectnaam.

Retouren

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Haal alle labels (tags) op die zijn toegewezen aan een pull-aanvraag.

function getPullRequestLabels(repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

projectId: string

Project-id of projectnaam.

Retouren

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Externe eigenschappen van de pull-aanvraag ophalen.

function getPullRequestProperties(repositoryId: string, pullRequestId: number, project?: string): Promise<any>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Deze API wordt gebruikt om te achterhalen welke pull-aanvragen betrekking hebben op een bepaalde doorvoer. Het kan worden gebruikt om de pull-aanvraag te vinden die een bepaalde samenvoegingsdoorvoering heeft gemaakt of kan worden gebruikt om alle pull-aanvragen te vinden die ooit een bepaalde doorvoer hebben samengevoegd. De invoer is een lijst met query's die elk een lijst met doorvoeringen bevatten. Voor elke doorvoering waarmee u zoekt, krijgt u een woordenlijst met doorvoerbewerkingen terug,> pull-aanvragen.

function getPullRequestQuery(queries: GitPullRequestQuery, repositoryId: string, project?: string): Promise<GitPullRequestQuery>

Parameters

queries: GitPullRequestQuery

De lijst met query's die moeten worden uitgevoerd.

repositoryId: string

Id van de opslagplaats.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Informatie ophalen over een bepaalde revisor in een pull-aanvraag

function getPullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

reviewerId: string

Id van de revisor.

project: string

Project-id of projectnaam

Retouren

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

De revisoren voor een pull-aanvraag ophalen

function getPullRequestReviewers(repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<IdentityRefWithVote[]>

getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)

Haal alle pull-aanvragen op die voldoen aan een opgegeven criteria.

function getPullRequests(repositoryId: string, searchCriteria: GitPullRequestSearchCriteria, project?: string, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

searchCriteria: GitPullRequestSearchCriteria

Pull-aanvragen worden geretourneerd die voldoen aan deze zoekcriteria.

project: string

Project-id of projectnaam

maxCommentLength: number

Niet gebruikt.

skip: number

Het aantal pull-aanvragen dat moet worden genegeerd. Als u bijvoorbeeld resultaten 101-150 wilt ophalen, stelt u de top in op 50 en gaat u verder met 100.

top: number

Het aantal pull-aanvragen dat moet worden opgehaald.

Retouren

Promise<GitPullRequest[]>

getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)

Haal alle pull-aanvragen op die voldoen aan een opgegeven criteria.

function getPullRequestsByProject(project: string, searchCriteria: GitPullRequestSearchCriteria, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

Parameters

project: string

Project-id of projectnaam

searchCriteria: GitPullRequestSearchCriteria

Pull-aanvragen worden geretourneerd die voldoen aan deze zoekcriteria.

maxCommentLength: number

Niet gebruikt.

skip: number

Het aantal pull-aanvragen dat moet worden genegeerd. Als u bijvoorbeeld resultaten 101-150 wilt ophalen, stelt u de top in op 50 en gaat u verder met 100.

top: number

Het aantal pull-aanvragen dat moet worden opgehaald.

Retouren

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Haal de specifieke status van de pull-aanvraag op id op. De status-id is uniek binnen de pull-aanvraag voor alle iteraties.

function getPullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

statusId: number

Id van de status van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Haal alle statussen op die zijn gekoppeld aan een pull-aanvraag.

function getPullRequestStatuses(repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestStatus[]>

getPullRequestThread(string, number, number, string, number, number)

Haal een thread op in een pull-aanvraag.

function getPullRequestThread(repositoryId: string, pullRequestId: number, threadId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

Id van de thread.

project: string

Project-id of projectnaam

iteration: number

Indien opgegeven, wordt de positie van de thread bijgehouden met behulp van deze iteratie als de rechterkant van het diff.

baseIteration: number

Indien opgegeven, wordt de positie van de thread bijgehouden met behulp van deze iteratie als de linkerkant van het diff.

Retouren

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Haal een lijst met werkitems op die zijn gekoppeld aan een pull-aanvraag.

function getPullRequestWorkItemRefs(repositoryId: string, pullRequestId: number, project?: string): Promise<ResourceRef[]>

Parameters

repositoryId: string

Id of naam van de opslagplaats.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<ResourceRef[]>

getPush(string, number, string, number, boolean)

Hiermee haalt u een bepaalde push op.

function getPush(repositoryId: string, pushId: number, project?: string, includeCommits?: number, includeRefUpdates?: boolean): Promise<GitPush>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

pushId: number

Id van de push.

project: string

Project-id of projectnaam

includeCommits: number

Het aantal doorvoeringen dat moet worden opgenomen in het resultaat.

includeRefUpdates: boolean

Indien waar, neemt u de lijst met refs op die zijn bijgewerkt door de push.

Retouren

Promise<GitPush>

getPushCommits(string, number, string, number, number, boolean)

Haal een lijst met doorvoeringen op die zijn gekoppeld aan een bepaalde push.

function getPushCommits(repositoryId: string, pushId: number, project?: string, top?: number, skip?: number, includeLinks?: boolean): Promise<GitCommitRef[]>

Parameters

repositoryId: string

De id of beschrijvende naam van de opslagplaats. Als u de beschrijvende naam wilt gebruiken, moet projectId ook worden opgegeven.

pushId: number

De id van de push.

project: string

Project-id of projectnaam

top: number

Het maximum aantal doorvoeringen dat moet worden geretourneerd ('haal de bovenste x doorvoeringen op').

skip: number

Het aantal doorvoeringen dat moet worden overgeslagen.

includeLinks: boolean

Ingesteld op onwaar om te voorkomen dat REST-URL-koppelingen voor resources worden opgenomen. De standaardwaarde is waar.

Retouren

Promise<GitCommitRef[]>

getPushes(string, string, number, number, GitPushSearchCriteria)

Hiermee worden pushes opgehaald die zijn gekoppeld aan de opgegeven opslagplaats.

function getPushes(repositoryId: string, project?: string, skip?: number, top?: number, searchCriteria?: GitPushSearchCriteria): Promise<GitPush[]>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

skip: number

Aantal pushes om over te slaan.

top: number

Aantal pushes dat moet worden geretourneerd.

searchCriteria: GitPushSearchCriteria

Kenmerken van zoekcriteria: fromDate, toDate, pusherId, refName, includeRefUpdates of includeLinks. fromDate: Begindatum om van te zoeken. toDate: Einddatum waarop moet worden gezocht. pusherId: identiteit van de persoon die de push heeft verzonden. refName: Branch name to consider. includeRefUpdates: Indien waar, neemt u de lijst met refs op die zijn bijgewerkt door de push. includeLinks: of het veld _links moet worden opgenomen in de ondiepe verwijzingen.

Retouren

Promise<GitPush[]>

getRecycleBinRepositories(string)

Haal voorlopig verwijderde Git-opslagplaatsen op uit de Prullenbak.

function getRecycleBinRepositories(project: string): Promise<GitDeletedRepository[]>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Hiermee haalt u de refs favoriet op voor een favoriete id.

function getRefFavorite(project: string, favoriteId: number): Promise<GitRefFavorite>

Parameters

project: string

Project-id of projectnaam

favoriteId: number

De id van de aangevraagde ref favoriet.

Retouren

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Haalt de refs-favorieten op voor een opslagplaats en een identiteit.

function getRefFavorites(project: string, repositoryId?: string, identityId?: string): Promise<GitRefFavorite[]>

Parameters

project: string

Project-id of projectnaam

repositoryId: string

De id van de opslagplaats.

identityId: string

De id van de identiteit waarvan de favorieten moeten worden opgehaald. Als null is, wordt de aanvraagidentiteit gebruikt.

Retouren

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

function getRefFavoritesForProject(project: string, identityId?: string): Promise<GitRefFavorite[]>

Parameters

project: string

Project-id of projectnaam

identityId: string

Retouren

Promise<GitRefFavorite[]>

getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)

Voert een query uit op de opgegeven opslagplaats voor de bijbehorende refs en retourneert deze.

function getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string): Promise<PagedList<GitRef>>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

filter: string

[optioneel] Een filter dat moet worden toegepast op de refs (begint met).

includeLinks: boolean

[optioneel] Hiermee geeft u op of referenceLinks moet worden opgenomen in het resultaat. de standaardwaarde is onwaar.

includeStatuses: boolean

[optioneel] Bevat maximaal de eerste 1000 doorvoerstatussen voor elke ref. De standaardwaarde is onwaar.

includeMyBranches: boolean

[optioneel] Bevat alleen vertakkingen die de gebruiker bezit, de vertakkingen die de gebruiker als favoriet heeft en de standaardbranch. De standaardwaarde is onwaar. Kan niet worden gecombineerd met de filterparameter.

latestStatusesOnly: boolean

[optioneel] Is waar om alleen de doorvoerstatus van de tip voor elke ref op te nemen. Voor deze optie moet includeStatuses waar zijn. De standaardwaarde is onwaar.

peelTags: boolean

[optioneel] Tags met aantekeningen vullen de eigenschap PeeledObjectId in. de standaardwaarde is onwaar.

filterContains: string

[optioneel] Een filter dat moet worden toegepast op de refs (contains).

Retouren

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Git-opslagplaatsen ophalen.

function getRepositories(project?: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean): Promise<GitRepository[]>

Parameters

project: string

Project-id of projectnaam

includeLinks: boolean

[optioneel] Waar om verwijzingskoppelingen op te nemen. De standaardwaarde is onwaar.

includeAllUrls: boolean

[optioneel] Is waar om alle externe URL's op te nemen. De standaardwaarde is onwaar.

includeHidden: boolean

[optioneel] Waar voor het opnemen van verborgen opslagplaatsen. De standaardwaarde is onwaar.

Retouren

Promise<GitRepository[]>

getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)

Git-opslagplaatsen ophalen met filteren op naam en paginering.

function getRepositoriesPaged(projectId: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean, filterContains?: string, top?: number, continuationToken?: string): Promise<PagedList<GitRepository>>

Parameters

projectId: string

Id of naam van het teamproject.

includeLinks: boolean

[optioneel] Waar om verwijzingskoppelingen op te nemen. De standaardwaarde is onwaar.

includeAllUrls: boolean

[optioneel] Is waar om alle externe URL's op te nemen. De standaardwaarde is onwaar.

includeHidden: boolean

[optioneel] Waar voor het opnemen van verborgen opslagplaatsen. De standaardwaarde is onwaar.

filterContains: string

[optioneel] Een filter dat moet worden toegepast op de refs (contains).

top: number

[optioneel] Maximum aantal opslagplaatsen dat moet worden geretourneerd. Het mag niet groter zijn dan 500. Als deze niet is opgegeven, maar vervolgToken is, wordt de bovenkant standaard ingesteld op 100.

continuationToken: string

Het vervolgtoken dat wordt gebruikt voor paginering.

Retouren

Promise<PagedList<GitRepository>>

getRepository(string, string)

Haal een Git-opslagplaats op.

function getRepository(repositoryId: string, project?: string): Promise<GitRepository>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

Retouren

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Haal een Git-opslagplaats op.

function getRepositoryWithParent(repositoryId: string, includeParent: boolean, project?: string): Promise<GitRepository>

Parameters

repositoryId: string

De naam of id van de opslagplaats.

includeParent: boolean

Waar voor het opnemen van bovenliggende opslagplaatsen. Alleen beschikbaar in geverifieerde aanroepen.

project: string

Project-id of projectnaam

Retouren

Promise<GitRepository>

getRevert(string, number, string)

Informatie over een herstelbewerking ophalen door de id te herstellen.

function getRevert(project: string, revertId: number, repositoryId: string): Promise<GitRevert>

Parameters

project: string

Project-id of projectnaam

revertId: number

Id van de terugdraaibewerking.

repositoryId: string

Id van de opslagplaats.

Retouren

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Eén conflict voor een terugdraaien per id ophalen

function getRevertConflict(repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

Parameters

repositoryId: string

revertId: number

conflictId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflict>

getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)

Alle conflicten voor een terugdraaiing ophalen

function getRevertConflicts(repositoryId: string, revertId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

Parameters

repositoryId: string

revertId: number

project: string

Project-id of projectnaam

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Retouren

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Informatie ophalen over een herstelbewerking voor een specifieke vertakking.

function getRevertForRefName(project: string, repositoryId: string, refName: string): Promise<GitRevert>

Parameters

project: string

Project-id of projectnaam

repositoryId: string

Id van de opslagplaats.

refName: string

De GitAsyncRefOperationParameters generatedRefName die wordt gebruikt voor de herstelbewerking.

Retouren

Promise<GitRevert>

getStatuses(string, string, string, number, number, boolean)

Statussen ophalen die zijn gekoppeld aan de Git-doorvoer.

function getStatuses(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number, latestOnly?: boolean): Promise<GitStatus[]>

Parameters

commitId: string

Id van de Git-doorvoer.

repositoryId: string

Id van de opslagplaats.

project: string

Project-id of projectnaam

top: number

Facultatief. Het aantal statussen dat moet worden opgehaald. De standaardwaarde is 1000.

skip: number

Facultatief. Het aantal statussen dat moet worden genegeerd. De standaardwaarde is 0. Als u bijvoorbeeld resultaten 101-150 wilt ophalen, stelt u de top in op 50 en gaat u verder met 100.

latestOnly: boolean

De vlag geeft aan of alleen de meest recente statussen worden gegroepeerd op Context.Name en Context.Genre.

Retouren

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Haal een suggestie voor een pull-aanvraag op voor een bepaalde opslagplaats of een teamproject.

function getSuggestions(repositoryId: string, project?: string, preferCompareBranch?: boolean): Promise<GitSuggestion[]>

Parameters

repositoryId: string

Id van de Git-opslagplaats.

project: string

Project-id of projectnaam

preferCompareBranch: boolean

Indien waar, geeft u de voorkeur aan de vergelijkingsbranch boven de standaardbranch als doelbranch voor pull-aanvragen.

Retouren

Promise<GitSuggestion[]>

getThreads(string, number, string, number, number)

Alle threads in een pull-aanvraag ophalen.

function getThreads(repositoryId: string, pullRequestId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread[]>

Parameters

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

iteration: number

Indien opgegeven, worden threadposities bijgehouden met behulp van deze iteratie als de rechterkant van de diff.

baseIteration: number

Indien opgegeven, worden threadposities bijgehouden met behulp van deze iteratie als de linkerkant van de diff.

Retouren

Promise<GitPullRequestCommentThread[]>

getTree(string, string, string, string, boolean, string)

Het tree-eindpunt retourneert de verzameling objecten onder de opgegeven structuur. Bomen zijn mappen in een Git-opslagplaats.

function getTree(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<GitTreeRef>

Parameters

repositoryId: string

Opslagplaats-id.

sha1: string

SHA1-hash van het structuurobject.

project: string

Project-id of projectnaam

projectId: string

Project-id.

recursive: boolean

Zoek recursief. Neem bomen onder deze boom op. De standaardwaarde is onwaar.

fileName: string

De naam die moet worden gebruikt als een .zip bestand wordt geretourneerd. De standaardwaarde is de object-id.

Retouren

Promise<GitTreeRef>

getTreeZip(string, string, string, string, boolean, string)

Het tree-eindpunt retourneert de verzameling objecten onder de opgegeven structuur. Bomen zijn mappen in een Git-opslagplaats.

function getTreeZip(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<ArrayBuffer>

Parameters

repositoryId: string

Opslagplaats-id.

sha1: string

SHA1-hash van het structuurobject.

project: string

Project-id of projectnaam

projectId: string

Project-id.

recursive: boolean

Zoek recursief. Neem bomen onder deze boom op. De standaardwaarde is onwaar.

fileName: string

De naam die moet worden gebruikt als een .zip bestand wordt geretourneerd. De standaardwaarde is de object-id.

Retouren

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Importeeraanvragen voor een opslagplaats ophalen.

function queryImportRequests(project: string, repositoryId: string, includeAbandoned?: boolean): Promise<GitImportRequest[]>

Parameters

project: string

Project-id of projectnaam

repositoryId: string

De naam of id van de opslagplaats.

includeAbandoned: boolean

Waar voor het opnemen van verlaten importaanvragen in de resultaten.

Retouren

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Een voorlopig verwijderde Git-opslagplaats herstellen. Onlangs verwijderde opslagplaatsen krijgen een status voor voorlopig verwijderen voordat ze hard worden verwijderd en kunnen ze niet meer worden hersteld.

function restoreRepositoryFromRecycleBin(repositoryDetails: GitRecycleBinRepositoryDetails, project: string, repositoryId: string): Promise<GitRepository>

Parameters

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

Project-id of projectnaam

repositoryId: string

De id van de opslagplaats.

Retouren

Promise<GitRepository>

setEnableOnCreateHost(boolean)

function setEnableOnCreateHost(enableOnCreateHost: boolean): Promise<void>

Parameters

enableOnCreateHost: boolean

Retouren

Promise<void>

setEnableOnCreateProject(string, boolean)

function setEnableOnCreateProject(enableOnCreateProjectId: string, enableOnStatus: boolean): Promise<void>

Parameters

enableOnCreateProjectId: string

enableOnStatus: boolean

Retouren

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Een e-mailmelding over een specifieke pull-aanvraag verzenden naar een set geadresseerden

function sharePullRequest(userMessage: ShareNotificationContext, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Parameters

userMessage: ShareNotificationContext

repositoryId: string

Id van de Git-opslagplaats.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<void>

updateCherryPickConflict(GitConflict, string, number, number, string)

Samenvoegingsconflictoplossing bijwerken

function updateCherryPickConflict(conflict: GitConflict, repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

Parameters

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflict>

updateCherryPickConflicts(GitConflict[], string, number, string)

Meerdere oplossingen voor samenvoegingsconflicten bijwerken

function updateCherryPickConflicts(conflictUpdates: GitConflict[], repositoryId: string, cherryPickId: number, project?: string): Promise<GitConflictUpdateResult[]>

Parameters

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflictUpdateResult[]>

updateComment(Comment, string, number, number, number, string)

Werk een opmerking bij die is gekoppeld aan een specifieke thread in een pull-aanvraag.

function updateComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

Parameters

comment: Comment

De inhoud van de opmerking die moet worden bijgewerkt. Opmerkingen kunnen maximaal 150.000 tekens zijn.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

Id van de thread waarin de gewenste opmerking zich bevindt.

commentId: number

Id van de opmerking die moet worden bijgewerkt.

project: string

Project-id of projectnaam

Retouren

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

POST-activeringsstatus voor opslagplaatsen.

function updateEnablementStatus(enablementUpdates: AdvSecEnablementUpdate[]): Promise<void>

Parameters

enablementUpdates: AdvSecEnablementUpdate[]

Retouren

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Een mislukte importaanvraag opnieuw proberen of afbreken.

function updateImportRequest(importRequestToUpdate: GitImportRequest, project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

Parameters

importRequestToUpdate: GitImportRequest

De bijgewerkte versie van de importaanvraag. De enige wijziging die is toegestaan, is het instellen van de status op In de wachtrij geplaatst of Afgelaten.

project: string

Project-id of projectnaam

repositoryId: string

De naam of id van de opslagplaats.

importRequestId: number

De unieke id voor de importaanvraag die moet worden bijgewerkt.

Retouren

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Een pull-aanvraag bijwerken

function updatePullRequest(gitPullRequestToUpdate: GitPullRequest, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequest>

Parameters

gitPullRequestToUpdate: GitPullRequest

De inhoud van de pull-aanvraag die moet worden bijgewerkt.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag die moet worden bijgewerkt.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequest>

updatePullRequestConflict(GitConflict, string, number, number, string)

Samenvoegingsconflictoplossing bijwerken

function updatePullRequestConflict(conflict: GitConflict, repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

Parameters

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflict>

updatePullRequestConflicts(GitConflict[], string, number, string)

Meerdere oplossingen voor samenvoegingsconflicten bijwerken

function updatePullRequestConflicts(conflictUpdates: GitConflict[], repositoryId: string, pullRequestId: number, project?: string): Promise<GitConflictUpdateResult[]>

Parameters

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflictUpdateResult[]>

updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)

Verzameling iteratiestatussen voor pull-aanvragen bijwerken. Het enige ondersteunde bewerkingstype is remove.

function updatePullRequestIterationStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<void>

Parameters

patchDocument: JsonPatchDocument

Bewerkingen die moeten worden toegepast op de statussen van de pull-aanvraag in JSON Patch-indeling.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

iterationId: number

Id van de iteratie van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Externe eigenschappen voor pull-aanvragen maken of bijwerken. De patchbewerking kan worden add, replace of remove. Voor add bewerking kan het pad leeg zijn. Als het pad leeg is, moet de waarde een lijst met sleutel-waardeparen zijn. Voor replace bewerking mag het pad niet leeg zijn. Als het pad niet bestaat, wordt de eigenschap toegevoegd aan de verzameling. Voor remove bewerking mag het pad niet leeg zijn. Als het pad niet bestaat, wordt er geen actie uitgevoerd.

function updatePullRequestProperties(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<any>

Parameters

patchDocument: JsonPatchDocument

Eigenschappen voor toevoegen, vervangen of verwijderen in JSON Patch-indeling.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<any>

updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)

Bewerk een revisorvermelding. Deze velden zijn patchable: isFlagged, hasDeclined

function updatePullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Parameters

reviewer: IdentityRefWithVote

Revisorgegevens.<br/>Als de revisor-id hier is opgenomen, moet deze overeenkomen met de parameter reviewerID.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

reviewerId: string

Id van de revisor.

project: string

Project-id of projectnaam

Retouren

Promise<IdentityRefWithVote>

updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)

Stel de stemmen van meerdere revisoren opnieuw in voor een pull-aanvraag. OPMERKING: Dit eindpunt ondersteunt alleen het bijwerken van stemmen, maar biedt geen ondersteuning voor het bijwerken van vereiste revisoren (beleid gebruiken) of weergavenamen.

function updatePullRequestReviewers(patchVotes: IdentityRefWithVote[], repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Parameters

patchVotes: IdentityRefWithVote[]

Id's van de revisoren waarvan de stemmen opnieuw worden ingesteld op nul

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag

project: string

Project-id of projectnaam

Retouren

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Verzameling pull-aanvraagstatussen bijwerken. Het enige ondersteunde bewerkingstype is remove.

function updatePullRequestStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Parameters

patchDocument: JsonPatchDocument

Bewerkingen die moeten worden toegepast op de statussen van de pull-aanvraag in JSON Patch-indeling.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

project: string

Project-id of projectnaam

Retouren

Promise<void>

updateRef(GitRefUpdate, string, string, string, string)

Een vertakking vergrendelen of ontgrendelen.

function updateRef(newRefInfo: GitRefUpdate, repositoryId: string, filter: string, project?: string, projectId?: string): Promise<GitRef>

Parameters

newRefInfo: GitRefUpdate

De actie voor het bijwerken van verw (vergrendelen/ontgrendelen) die moet worden uitgevoerd

repositoryId: string

De naam of id van de opslagplaats.

filter: string

De naam van de vertakking die moet worden vergrendeld/ontgrendeld

project: string

Project-id of projectnaam

projectId: string

Id of naam van het teamproject. Optioneel als u een id voor de opslagplaats opgeeft.

Retouren

Promise<GitRef>

updateRefs(GitRefUpdate[], string, string, string)

Refs(vertakkingen) maken, bijwerken of verwijderen.

function updateRefs(refUpdates: GitRefUpdate[], repositoryId: string, project?: string, projectId?: string): Promise<GitRefUpdateResult[]>

Parameters

refUpdates: GitRefUpdate[]

Lijst met ref-updates die moeten worden uitgevoerd

repositoryId: string

De naam of id van de opslagplaats.

project: string

Project-id of projectnaam

projectId: string

Id of naam van het teamproject. Optioneel als u een id voor de opslagplaats opgeeft.

Retouren

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Hiermee werkt u de Git-opslagplaats bij met een nieuwe opslagplaatsnaam of een nieuwe standaardvertakking.

function updateRepository(newRepositoryInfo: GitRepository, repositoryId: string, project?: string): Promise<GitRepository>

Parameters

newRepositoryInfo: GitRepository

Geef een nieuwe opslagplaatsnaam of een nieuwe standaardvertakking van de opslagplaats op

repositoryId: string

De id van de opslagplaats.

project: string

Project-id of projectnaam

Retouren

Promise<GitRepository>

updateRevertConflict(GitConflict, string, number, number, string)

Samenvoegingsconflictoplossing bijwerken

function updateRevertConflict(conflict: GitConflict, repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

Parameters

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflict>

updateRevertConflicts(GitConflict[], string, number, string)

Meerdere oplossingen voor samenvoegingsconflicten bijwerken

function updateRevertConflicts(conflictUpdates: GitConflict[], repositoryId: string, revertId: number, project?: string): Promise<GitConflictUpdateResult[]>

Parameters

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

Project-id of projectnaam

Retouren

Promise<GitConflictUpdateResult[]>

updateThread(GitPullRequestCommentThread, string, number, number, string)

Een thread in een pull-aanvraag bijwerken.

function updateThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<GitPullRequestCommentThread>

Parameters

commentThread: GitPullRequestCommentThread

De thread-inhoud die moet worden bijgewerkt.

repositoryId: string

De opslagplaats-id van de doelbranch van de pull-aanvraag.

pullRequestId: number

Id van de pull-aanvraag.

threadId: number

Id van de thread die moet worden bijgewerkt.

project: string

Project-id of projectnaam

Retouren

Promise<GitPullRequestCommentThread>

Delen via

GitRestClient class

Constructors

Eigenschappen

Methoden

Constructordetails

GitRestClient(IVssRestClientOptions)

Parameters

Eigenschapdetails

RESOURCE_AREA_ID

Waarde van eigenschap

Methodedetails

createAnnotatedTag(GitAnnotatedTag, string, string)

Parameters

Retouren

createAttachment(any, string, string, number, string)

Parameters

Retouren

createCherryPick(GitAsyncRefOperationParameters, string, string)

Parameters

Retouren

createComment(Comment, string, number, number, string)

Parameters

Retouren

createCommitStatus(GitStatus, string, string, string)

Parameters

Retouren

createFavorite(GitRefFavorite, string)

Parameters

Retouren

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Parameters

Retouren

createImportRequest(GitImportRequest, string, string)

Parameters

Retouren

createLike(string, number, number, number, string)

Parameters

Retouren

createMergeRequest(GitMergeParameters, string, string, boolean)

Parameters

Retouren

createPullRequest(GitPullRequest, string, string, boolean)

Parameters

Retouren

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

Parameters

Retouren

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

Parameters

Retouren

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

Parameters

Retouren

createPullRequestReviewers(IdentityRef[], string, number, string)

Parameters

Retouren

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Parameters

Retouren

createPush(GitPush, string, string)

Parameters

Retouren

createRepository(GitRepositoryCreateOptions, string, string)

Parameters

Retouren

createRevert(GitAsyncRefOperationParameters, string, string)

Parameters

Retouren

createThread(GitPullRequestCommentThread, string, number, string)

Parameters

Retouren

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Parameters

Retouren

deleteAttachment(string, string, number, string)

Parameters

Retouren

deleteComment(string, number, number, number, string)

Parameters