GitRestClient class
Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss
- Extends
Costruttori
Git |
Proprietà
RESOURCE_AREA_ID |
Metodi
create |
Creare un tag annotato. |
create |
Collegare un nuovo file a una richiesta pull. |
create |
Cherry seleziona un commit o commit specifici associati a una richiesta pull in un nuovo ramo. |
create |
Creare un commento su un thread specifico in una richiesta pull (è possibile creare fino a 500 commenti per ogni thread). |
create |
Creare lo stato del commit Git. |
create |
Crea un riferimento preferito |
create |
Richiedere che i riferimenti di un altro repository vengano recuperati in questo repository. Sincronizza due fork esistenti. Per creare un fork, vedere l'endpoint <href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> repository</a> |
create |
Creare una richiesta di importazione. |
create |
Aggiungere un like a un commento. |
create |
Richiedere un'operazione git merge. Attualmente è supportato l'unione di soli 2 commit. |
create |
Creare una richiesta pull. |
create |
Creare uno stato della richiesta pull nell'iterazione. Questa operazione avrà lo stesso risultato di Create status on pull request with specified iteration ID nel corpo della richiesta. |
create |
Creare un tag (se non esiste già) e aggiungerlo come etichetta (tag) per una richiesta pull specificata. L'unico campo obbligatorio è il nome della nuova etichetta (tag). |
create |
Aggiungere un revisore a una richiesta pull o eseguire un voto. |
create |
Aggiungere revisori a una richiesta pull. |
create |
Creare uno stato della richiesta pull. |
create |
Eseguire il push delle modifiche nel repository. |
create |
Creare un repository Git in un progetto team. |
create |
Avvia l'operazione per creare un nuovo ramo che ripristina le modifiche introdotte da un commit o commit specifici associati a una richiesta pull. |
create |
Creare un thread in una richiesta pull. |
create |
Aggiungere un'identità non materializzata ai revisori di una richiesta pull. |
delete |
Eliminare un allegato della richiesta pull. |
delete |
Eliminare un commento associato a un thread specifico in una richiesta pull. |
delete |
DELETE Elimina lo stato di abilitazione e i dati BillableCommitters dal database. L'eliminazione dei dati di abilitazione disabilita in modo efficace per i repository interessati. |
delete |
Eliminare un commento come in un commento. |
delete |
Eliminare lo stato di iterazione della richiesta pull. |
delete |
Rimuove un'etichetta (tag) dal set di quelli assegnati alla richiesta pull. Il tag stesso non verrà eliminato. |
delete |
Rimuovere un revisore da una richiesta pull. |
delete |
Eliminare lo stato della richiesta pull. |
delete |
Elimina i ref preferiti specificati |
delete |
Eliminare un repository Git |
delete |
Eliminare (eliminazione temporanea) un repository Git eliminato in modo temporaneo. |
get |
Ottenere un tag annotato. |
get |
Ottenere il contenuto del file di un allegato della richiesta pull. |
get |
Ottenere un elenco di file collegati a una determinata richiesta pull. |
get |
Ottenere il contenuto del file di un allegato della richiesta pull. |
get |
Recuperare i commit fatturabili effettivi per il servizio di sicurezza avanzata per una data specificata. |
get |
Recuperare i commit fatturabili effettivi dettagliati per il servizio di sicurezza avanzata per una data specificata. I risultati dettagliati non filtrano intenzionalmente progetti e repository eliminati temporanea per diagnosticare i problemi di fatturazione. |
get |
Ottenere un singolo BLOB. |
get |
Ottenere un singolo BLOB. |
get |
Ottiene uno o più BLOB in un download di file ZIP. |
get |
Ottenere un singolo BLOB. |
get |
Recuperare le statistiche su un singolo ramo. |
get |
Recuperare statistiche su tutti i rami all'interno di un repository. |
get |
Recuperare le statistiche per più commit |
get |
Recuperare le modifiche per un determinato commit. |
get |
Recuperare informazioni su un'operazione di selezione ciliegia in base all'ID selezione ciliegia. |
get |
Recuperare un conflitto per una selezione di ciliegia in base all'ID |
get |
Recuperare tutti i conflitti per un'opzione cherry pick |
get |
Recuperare informazioni su un'operazione cherry pick per un ramo specifico. Questa operazione è costosa a causa della struttura dell'oggetto sottostante, quindi questa API esamina solo le 1000 operazioni di selezione ciliegie più recenti. |
get |
Dato un commitId, restituisce un elenco di commit che si trovano nella stessa famiglia cherry-pick. |
get |
Recuperare un commento associato a un thread specifico in una richiesta pull. |
get |
Recuperare tutti i commenti associati a un thread specifico in una richiesta pull. |
get |
Recuperare un determinato commit. |
get |
Trovare il commit comune più vicino (base di merge) tra i commit di base e di destinazione e ottenere il diff tra i commit di base e di destinazione o i commit comuni e di destinazione. |
get |
Recuperare i commit Git per un progetto |
get |
Recuperare i commit Git per un progetto che corrisponde ai criteri di ricerca |
get |
Recuperare i repository Git eliminati. |
get |
GET Stato di abilitazione per i repository del progetto. |
get |
|
get |
|
get |
Ottenere i commit fatturabili stimati per un repository per gli ultimi 90 giorni. |
get |
Ottenere i push fatturabili stimati per un'organizzazione per gli ultimi 90 giorni. |
get |
Ottenere push fatturabili stimati per un progetto per gli ultimi 90 giorni. |
get |
Ottenere le differenze di file per ognuno dei file specificati |
get |
Recuperare tutti i fork di un repository nella raccolta. |
get |
Ottenere i dettagli di un'operazione di sincronizzazione fork specifica. |
get |
Recuperare tutte le operazioni di sincronizzazione fork richieste in questo repository. |
get |
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download. |
get |
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download. |
get |
Ottiene i metadati e/o il contenuto dell'elemento per una raccolta di elementi. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download. |
get |
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download. |
get |
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download. |
get |
Recuperare una richiesta di importazione specifica. |
get |
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download. |
get |
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download. |
get |
Ottiene i metadati e/o il contenuto dell'elemento per una raccolta di elementi. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download. |
get |
Post per il recupero di una creazione di un batch da un set di elementi in un repository/progetto in base a un elenco di percorsi o a un percorso lungo |
get |
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download. |
get |
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download. |
get |
Ottieni mi piace per un commento. |
get |
Trovare le basi di merge di due commit, facoltativamente tra fork. Se non viene specificato otherRepositoryId, le basi di merge verranno calcolate solo nel contesto del repository localeNameOrId. |
get |
Ottenere i dettagli di un'operazione di merge specifica. |
get |
Get Advanced Security Permission status (Stato dell'autorizzazione di sicurezza avanzata GET). |
get |
Recuperare una richiesta pull. |
get |
Recuperare una richiesta pull. |
get |
Ottenere i commit per la richiesta pull specificata. |
get |
Recuperare un conflitto per una richiesta pull in base all'ID |
get |
Recuperare tutti i conflitti per una richiesta pull |
get |
Ottenere l'iterazione specificata per una richiesta pull. |
get |
Recuperare le modifiche apportate in una richiesta pull tra due iterazioni. |
get |
Ottenere i commit per l'iterazione specificata di una richiesta pull. |
get |
Ottenere l'elenco di iterazioni per la richiesta pull specificata. |
get |
Ottenere lo stato di iterazione della richiesta pull specifico in base all'ID. L'ID di stato è univoco all'interno della richiesta pull in tutte le iterazioni. |
get |
Ottenere tutti gli stati associati a un'iterazione della richiesta pull. |
get |
Recupera una singola etichetta (tag) assegnata a una richiesta pull. |
get |
Ottenere tutte le etichette (tag) assegnate a una richiesta pull. |
get |
Ottiene le proprietà esterne della richiesta pull. |
get |
Questa API viene usata per trovare le richieste pull correlate a un determinato commit. Può essere usato per trovare la richiesta pull che ha creato un commit di merge specifico oppure può essere usata per trovare tutte le richieste pull che hanno mai unito un determinato commit. L'input è un elenco di query che contengono un elenco di commit. Per ogni commit su cui si esegue la ricerca, si otterrà un dizionario di commit-> richieste pull. |
get |
Recuperare informazioni su un determinato revisore in una richiesta pull |
get |
Recuperare i revisori per una richiesta pull |
get |
Recuperare tutte le richieste pull corrispondenti a un criterio specificato. |
get |
Recuperare tutte le richieste pull corrispondenti a criteri specificati. |
get |
Ottenere lo stato della richiesta pull specifica in base all'ID. L'ID di stato è univoco all'interno della richiesta pull in tutte le iterazioni. |
get |
Ottenere tutti gli stati associati a una richiesta pull. |
get |
Recuperare un thread in una richiesta pull. |
get |
Recuperare un elenco di elementi di lavoro associati a una richiesta pull. |
get |
Recupera un push specifico. |
get |
Recuperare un elenco di commit associati a un push specifico. |
get |
Recupera i push associati al repository specificato. |
get |
Recuperare i repository Git eliminati in modo leggero dal cestino. |
get |
Ottiene i valori preferiti per un ID preferito. |
get |
Ottiene i preferiti di riferimento per un repository e un'identità. |
get |
|
get |
Esegue query sul repository fornito per i relativi ref e li restituisce. |
get |
Recuperare i repository git. |
get |
Recuperare un repository git. |
get |
Recuperare un repository git. |
get |
Recuperare informazioni su un'operazione di ripristino ripristinando l'ID. |
get |
Recuperare un conflitto per un revert by ID |
get |
Recuperare tutti i conflitti per un ripristino |
get |
Recuperare informazioni su un'operazione di ripristino per un ramo specifico. |
get |
Ottenere gli stati associati al commit Git. |
get |
Recuperare un suggerimento di richiesta pull per un determinato repository o progetto team. |
get |
Recuperare tutti i thread in una richiesta pull. |
get |
L'endpoint Tree restituisce la raccolta di oggetti sotto l'albero specificato. Gli alberi sono cartelle in un repository Git. |
get |
L'endpoint Tree restituisce la raccolta di oggetti sotto l'albero specificato. Gli alberi sono cartelle in un repository Git. |
query |
Recuperare le richieste di importazione per un repository. |
restore |
Ripristinare un repository Git eliminato in modo temporaneo. I repository eliminati di recente entrano in uno stato di eliminazione temporanea per un periodo di tempo prima che vengano eliminati e diventino non recuperabili. |
set |
|
set |
|
share |
Invia una notifica di posta elettronica su una richiesta pull specifica a un set di destinatari |
update |
Aggiornare la risoluzione dei conflitti di unione |
update |
Aggiornare più risoluzioni dei conflitti di tipo merge |
update |
Aggiornare un commento associato a un thread specifico in una richiesta pull. |
update |
Stato di abilitazione POST per i repository. |
update |
Riprovare o abbandonare una richiesta di importazione non riuscita. |
update |
Aggiornare una richiesta pull |
update |
Aggiornare la risoluzione dei conflitti di unione |
update |
Aggiornare più risoluzioni dei conflitti di tipo merge |
update |
Aggiornare la raccolta di stato delle richieste pull. L'unico tipo di operazione supportato è |
update |
Creare o aggiornare le proprietà esterne della richiesta pull. L'operazione di patch può essere |
update |
Modificare una voce di revisore. Questi campi sono patchable: isFlagged, hasDeclined |
update |
Reimpostare i voti di più revisori in una richiesta pull. NOTA: questo endpoint supporta solo l'aggiornamento dei voti, ma non supporta l'aggiornamento dei revisori richiesti (usare i criteri) o i nomi visualizzati. |
update |
Aggiornare la raccolta degli stati delle richieste pull. L'unico tipo di operazione supportato è |
update |
Bloccare o sbloccare un ramo. |
update |
Creazione, aggiornamento o eliminazione di refs(rami). |
update |
Aggiorna il repository Git con un nuovo nome di repository o un nuovo ramo predefinito. |
update |
Aggiornare la risoluzione dei conflitti di merge |
update |
Aggiornare più risoluzioni dei conflitti di merge |
update |
Aggiornare un thread in una richiesta pull. |
Dettagli costruttore
GitRestClient(IVssRestClientOptions)
Dettagli proprietà
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
Valore della proprietà
string
Dettagli metodo
createAnnotatedTag(GitAnnotatedTag, string, string)
Creare un tag annotato.
function createAnnotatedTag(tagObject: GitAnnotatedTag, project: string, repositoryId: string): Promise<GitAnnotatedTag>
Parametri
- tagObject
- GitAnnotatedTag
Oggetto contenente i dettagli del tag da creare.
- project
-
string
ID progetto o nome progetto
- repositoryId
-
string
ID o nome del repository.
Restituisce
Promise<GitAnnotatedTag>
createAttachment(any, string, string, number, string)
Collegare un nuovo file a una richiesta pull.
function createAttachment(content: any, fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment>
Parametri
- content
-
any
Contenuto da caricare
- fileName
-
string
Nome del file.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<Attachment>
createCherryPick(GitAsyncRefOperationParameters, string, string)
Cherry seleziona un commit o commit specifici associati a una richiesta pull in un nuovo ramo.
function createCherryPick(cherryPickToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitCherryPick>
Parametri
- cherryPickToCreate
- GitAsyncRefOperationParameters
- project
-
string
ID progetto o nome del progetto
- repositoryId
-
string
ID del repository.
Restituisce
Promise<GitCherryPick>
createComment(Comment, string, number, number, string)
Creare un commento su un thread specifico in una richiesta pull (è possibile creare fino a 500 commenti per ogni thread).
function createComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment>
Parametri
- comment
- Comment
Commento da creare. I commenti possono contenere fino a 150.000 caratteri.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread in cui si trova il commento desiderato.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<Comment>
createCommitStatus(GitStatus, string, string, string)
Creare lo stato del commit Git.
function createCommitStatus(gitCommitStatusToCreate: GitStatus, commitId: string, repositoryId: string, project?: string): Promise<GitStatus>
Parametri
- gitCommitStatusToCreate
- GitStatus
Oggetto stato commit Git da creare.
- commitId
-
string
ID del commit Git.
- repositoryId
-
string
ID del repository.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitStatus>
createFavorite(GitRefFavorite, string)
Crea un riferimento preferito
function createFavorite(favorite: GitRefFavorite, project: string): Promise<GitRefFavorite>
Parametri
- favorite
- GitRefFavorite
Riferimento preferito da creare.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitRefFavorite>
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)
Richiedere che i riferimenti di un altro repository vengano recuperati in questo repository. Sincronizza due fork esistenti. Per creare un fork, vedere l'endpoint <href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> repository</a>
function createForkSyncRequest(syncParams: GitForkSyncRequestParameters, repositoryNameOrId: string, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>
Parametri
- syncParams
- GitForkSyncRequestParameters
Repository di origine e mapping dei riferimenti.
- repositoryNameOrId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- includeLinks
-
boolean
True per includere i collegamenti
Restituisce
Promise<GitForkSyncRequest>
createImportRequest(GitImportRequest, string, string)
Creare una richiesta di importazione.
function createImportRequest(importRequest: GitImportRequest, project: string, repositoryId: string): Promise<GitImportRequest>
Parametri
- importRequest
- GitImportRequest
Richiesta di importazione da creare.
- project
-
string
ID progetto o nome del progetto
- repositoryId
-
string
Nome o ID del repository.
Restituisce
Promise<GitImportRequest>
createLike(string, number, number, number, string)
Aggiungere un like a un commento.
function createLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread che contiene il commento.
- commentId
-
number
ID del commento.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<void>
createMergeRequest(GitMergeParameters, string, string, boolean)
Richiedere un'operazione git merge. Attualmente è supportato l'unione di soli 2 commit.
function createMergeRequest(mergeParameters: GitMergeParameters, project: string, repositoryNameOrId: string, includeLinks?: boolean): Promise<GitMerge>
Parametri
- mergeParameters
- GitMergeParameters
CommitId padre e merge commit messsage.
- project
-
string
ID progetto o nome del progetto
- repositoryNameOrId
-
string
Nome o ID del repository.
- includeLinks
-
boolean
True per includere i collegamenti
Restituisce
Promise<GitMerge>
createPullRequest(GitPullRequest, string, string, boolean)
Creare una richiesta pull.
function createPullRequest(gitPullRequestToCreate: GitPullRequest, repositoryId: string, project?: string, supportsIterations?: boolean): Promise<GitPullRequest>
Parametri
- gitPullRequestToCreate
- GitPullRequest
Richiesta pull da creare.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- project
-
string
ID progetto o nome del progetto
- supportsIterations
-
boolean
Se true, i push successivi alla richiesta pull saranno verificabili singolarmente. Impostare questo valore su false per richieste pull di grandi dimensioni per motivi di prestazioni se questa funzionalità non è necessaria.
Restituisce
Promise<GitPullRequest>
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)
Creare uno stato della richiesta pull nell'iterazione. Questa operazione avrà lo stesso risultato di Create status on pull request with specified iteration ID nel corpo della richiesta.
function createPullRequestIterationStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus>
Parametri
- status
- GitPullRequestStatus
Stato della richiesta pull da creare.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- iterationId
-
number
ID dell'iterazione della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequestStatus>
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)
Creare un tag (se non esiste già) e aggiungerlo come etichetta (tag) per una richiesta pull specificata. L'unico campo obbligatorio è il nome della nuova etichetta (tag).
function createPullRequestLabel(label: WebApiCreateTagRequestData, repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition>
Parametri
Etichetta da assegnare alla richiesta pull.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
- projectId
-
string
ID progetto o nome del progetto.
Restituisce
Promise<WebApiTagDefinition>
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)
Aggiungere un revisore a una richiesta pull o eseguire un voto.
function createPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>
Parametri
- reviewer
- IdentityRefWithVote
Voto del revisore.<br />If l'ID del revisore è incluso qui, deve corrispondere al parametro reviewerID.<br />Reviewers può impostare il proprio voto con questo metodo. Quando si aggiungono altri revisori, il voto deve essere impostato su zero.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- reviewerId
-
string
ID del revisore.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<IdentityRefWithVote>
createPullRequestReviewers(IdentityRef[], string, number, string)
Aggiungere revisori a una richiesta pull.
function createPullRequestReviewers(reviewers: IdentityRef[], repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>
Parametri
- reviewers
Revisori da aggiungere alla richiesta pull.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<IdentityRefWithVote[]>
createPullRequestStatus(GitPullRequestStatus, string, number, string)
Creare uno stato della richiesta pull.
function createPullRequestStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus>
Parametri
- status
- GitPullRequestStatus
Stato della richiesta pull da creare.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequestStatus>
createPush(GitPush, string, string)
Eseguire il push delle modifiche nel repository.
function createPush(push: GitPush, repositoryId: string, project?: string): Promise<GitPush>
Parametri
- push
- GitPush
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPush>
createRepository(GitRepositoryCreateOptions, string, string)
Creare un repository Git in un progetto team.
function createRepository(gitRepositoryToCreate: GitRepositoryCreateOptions, project?: string, sourceRef?: string): Promise<GitRepository>
Parametri
- gitRepositoryToCreate
- GitRepositoryCreateOptions
Specificare il nome del repository, il progetto team e/o il repository padre. Le informazioni sul progetto team possono essere omesse da gitRepositoryToCreate se la richiesta è con ambito progetto (ad esempio, include l'ID progetto).
- project
-
string
ID progetto o nome del progetto
- sourceRef
-
string
[facoltativo] Specificare i riferimenti di origine da usare durante la creazione di un repository fork
Restituisce
Promise<GitRepository>
createRevert(GitAsyncRefOperationParameters, string, string)
Avvia l'operazione per creare un nuovo ramo che ripristina le modifiche introdotte da un commit o commit specifici associati a una richiesta pull.
function createRevert(revertToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitRevert>
Parametri
- revertToCreate
- GitAsyncRefOperationParameters
- project
-
string
ID progetto o nome del progetto
- repositoryId
-
string
ID del repository.
Restituisce
Promise<GitRevert>
createThread(GitPullRequestCommentThread, string, number, string)
Creare un thread in una richiesta pull.
function createThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestCommentThread>
Parametri
- commentThread
- GitPullRequestCommentThread
Thread da creare. Il thread deve contenere almeno un commento.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequestCommentThread>
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)
Aggiungere un'identità non materializzata ai revisori di una richiesta pull.
function createUnmaterializedPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote>
Parametri
- reviewer
- IdentityRefWithVote
Revisore da aggiungere alla richiesta pull.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<IdentityRefWithVote>
deleteAttachment(string, string, number, string)
Eliminare un allegato della richiesta pull.
function deleteAttachment(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<void>
Parametri
- fileName
-
string
Nome dell'allegato da eliminare.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
deleteComment(string, number, number, number, string)
Eliminare un commento associato a un thread specifico in una richiesta pull.
function deleteComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread in cui si trova il commento desiderato.
- commentId
-
number
ID del commento.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
deleteEnablementStatus(boolean, boolean, string[])
DELETE Elimina lo stato di abilitazione e i dati BillableCommitters dal database. L'eliminazione dei dati di abilitazione disabilita in modo efficace per i repository interessati.
function deleteEnablementStatus(allProjects: boolean, includeBillableCommitters?: boolean, projectIds?: string[]): Promise<void>
Parametri
- allProjects
-
boolean
- includeBillableCommitters
-
boolean
- projectIds
-
string[]
Restituisce
Promise<void>
deleteLike(string, number, number, number, string)
Eliminare un commento come in un commento.
function deleteLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread contenente il commento.
- commentId
-
number
ID del commento.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
deletePullRequestIterationStatus(string, number, number, number, string)
Eliminare lo stato di iterazione della richiesta pull.
function deletePullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<void>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- iterationId
-
number
ID dell'iterazione della richiesta pull.
- statusId
-
number
ID dello stato della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
deletePullRequestLabels(string, number, string, string, string)
Rimuove un'etichetta (tag) dal set di quelli assegnati alla richiesta pull. Il tag stesso non verrà eliminato.
function deletePullRequestLabels(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<void>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- labelIdOrName
-
string
Nome o ID dell'etichetta richiesta.
- project
-
string
ID progetto o nome progetto
- projectId
-
string
ID progetto o nome progetto.
Restituisce
Promise<void>
deletePullRequestReviewer(string, number, string, string)
Rimuovere un revisore da una richiesta pull.
function deletePullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<void>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- reviewerId
-
string
ID del revisore da rimuovere.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
deletePullRequestStatus(string, number, number, string)
Eliminare lo stato della richiesta pull.
function deletePullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<void>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- statusId
-
number
ID dello stato della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
deleteRefFavorite(string, number)
Elimina i ref preferiti specificati
function deleteRefFavorite(project: string, favoriteId: number): Promise<void>
Parametri
- project
-
string
ID progetto o nome progetto
- favoriteId
-
number
ID del riferimento preferito da eliminare.
Restituisce
Promise<void>
deleteRepository(string, string)
Eliminare un repository Git
function deleteRepository(repositoryId: string, project?: string): Promise<void>
Parametri
- repositoryId
-
string
ID del repository.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
deleteRepositoryFromRecycleBin(string, string)
Eliminare (eliminazione temporanea) un repository Git eliminato in modo temporaneo.
function deleteRepositoryFromRecycleBin(project: string, repositoryId: string): Promise<void>
Parametri
- project
-
string
ID progetto o nome progetto
- repositoryId
-
string
ID del repository.
Restituisce
Promise<void>
getAnnotatedTag(string, string, string)
Ottenere un tag annotato.
function getAnnotatedTag(project: string, repositoryId: string, objectId: string): Promise<GitAnnotatedTag>
Parametri
- project
-
string
ID progetto o nome progetto
- repositoryId
-
string
ID o nome del repository.
- objectId
-
string
ObjectId (Sha1Id) di tag da ottenere.
Restituisce
Promise<GitAnnotatedTag>
getAttachmentContent(string, string, number, string)
Ottenere il contenuto del file di un allegato della richiesta pull.
function getAttachmentContent(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>
Parametri
- fileName
-
string
Nome dell'allegato.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ArrayBuffer>
getAttachments(string, number, string)
Ottenere un elenco di file collegati a una determinata richiesta pull.
function getAttachments(repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<Attachment[]>
getAttachmentZip(string, string, number, string)
Ottenere il contenuto del file di un allegato della richiesta pull.
function getAttachmentZip(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>
Parametri
- fileName
-
string
Nome dell'allegato.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ArrayBuffer>
getBillableCommitters(string, Date, number, number)
Recuperare i commit fatturabili effettivi per il servizio di sicurezza avanzata per una data specificata.
function getBillableCommitters(project: string, billingDate?: Date, skip?: number, take?: number): Promise<BillableCommitter[]>
Parametri
- project
-
string
ID progetto o nome progetto
- billingDate
-
Date
Previsto utc. Se non è specificato il valore predefinito per il giorno di fatturazione precedente.
- skip
-
number
Ignorare le righe X del set di risultati per simulare il paging.
- take
-
number
Restituire righe Y del set di risultati per simulare il paging.
Restituisce
Promise<BillableCommitter[]>
getBillableCommittersDetail(string, string, Date)
Recuperare i commit fatturabili effettivi dettagliati per il servizio di sicurezza avanzata per una data specificata. I risultati dettagliati non filtrano intenzionalmente progetti e repository eliminati temporanea per diagnosticare i problemi di fatturazione.
function getBillableCommittersDetail(project: string, includeDetails: string, billingDate?: Date): Promise<BillableCommitterDetail[]>
Parametri
- project
-
string
ID progetto o nome progetto
- includeDetails
-
string
Restituisce tutti i dettagli sui commit fatturabili.
- billingDate
-
Date
Previsto utc. Se non è specificato il valore predefinito per il giorno di fatturazione precedente.
Restituisce
Promise<BillableCommitterDetail[]>
getBlob(string, string, string, boolean, string, boolean)
Ottenere un singolo BLOB.
function getBlob(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<GitBlobRef>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- sha1
-
string
HASH SHA1 del file. È possibile ottenere SHA1 di un file usando l'endpoint "Git/Items/Get Item".
- project
-
string
ID progetto o nome progetto
- download
-
boolean
Se true, richiedere un download anziché eseguire il rendering in un browser. Nota: il valore predefinito è true se $format è zip
- fileName
-
string
Specificare un fileName da usare per un download.
- resolveLfs
-
boolean
Se true, provare a risolvere un BLOB nel relativo contenuto LFS, se si tratta di un file di puntatore LFS. Compatibile solo con le intestazioni Di accettazione di ottet-stream o i tipi di $format
Restituisce
Promise<GitBlobRef>
getBlobContent(string, string, string, boolean, string, boolean)
Ottenere un singolo BLOB.
function getBlobContent(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- sha1
-
string
HASH SHA1 del file. È possibile ottenere SHA1 di un file usando l'endpoint "Git/Items/Get Item".
- project
-
string
ID progetto o nome progetto
- download
-
boolean
Se true, richiedere un download anziché eseguire il rendering in un browser. Nota: il valore predefinito è true se $format è zip
- fileName
-
string
Specificare un fileName da usare per un download.
- resolveLfs
-
boolean
Se true, provare a risolvere un BLOB nel relativo contenuto LFS, se si tratta di un file di puntatore LFS. Compatibile solo con le intestazioni accept o i tipi di $format octet-stream
Restituisce
Promise<ArrayBuffer>
getBlobsZip(string[], string, string, string)
Ottiene uno o più BLOB in un download di file ZIP.
function getBlobsZip(blobIds: string[], repositoryId: string, project?: string, filename?: string): Promise<ArrayBuffer>
Parametri
- blobIds
-
string[]
ID BLOB (hash SHA1) da restituire nel file ZIP.
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- filename
-
string
Restituisce
Promise<ArrayBuffer>
getBlobZip(string, string, string, boolean, string, boolean)
Ottenere un singolo BLOB.
function getBlobZip(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- sha1
-
string
Hash SHA1 del file. È possibile ottenere SHA1 di un file usando l'endpoint "Git/Items/Get Item".
- project
-
string
ID progetto o nome del progetto
- download
-
boolean
Se true, richiedere un download anziché eseguire il rendering in un browser. Nota: il valore predefinito è true se $format è zip
- fileName
-
string
Specificare un fileName da usare per un download.
- resolveLfs
-
boolean
Se true, provare a risolvere un BLOB nel relativo contenuto LFS, se si tratta di un file di puntatore LFS. Compatibile solo con le intestazioni accept o i tipi di $format octet-stream
Restituisce
Promise<ArrayBuffer>
getBranch(string, string, string, GitVersionDescriptor)
Recuperare le statistiche su un singolo ramo.
function getBranch(repositoryId: string, name: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- name
-
string
Nome del ramo.
- project
-
string
ID progetto o nome del progetto
- baseVersionDescriptor
- GitVersionDescriptor
Identifica il commit o il ramo da utilizzare come base.
Restituisce
Promise<GitBranchStats>
getBranches(string, string, GitVersionDescriptor)
Recuperare statistiche su tutti i rami all'interno di un repository.
function getBranches(repositoryId: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats[]>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- baseVersionDescriptor
- GitVersionDescriptor
Identifica il commit o il ramo da utilizzare come base.
Restituisce
Promise<GitBranchStats[]>
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)
Recuperare le statistiche per più commit
function getBranchStatsBatch(searchCriteria: GitQueryBranchStatsCriteria, repositoryId: string, project?: string): Promise<GitBranchStats[]>
Parametri
- searchCriteria
- GitQueryBranchStatsCriteria
Commit di base e elenco di commit di destinazione da confrontare.
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitBranchStats[]>
getChanges(string, string, string, number, number)
Recuperare le modifiche per un determinato commit.
function getChanges(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number): Promise<GitCommitChanges>
Parametri
- commitId
-
string
ID del commit.
- repositoryId
-
string
ID o nome descrittivo del repository. Per usare il nome descrittivo, è necessario specificare anche projectId.
- project
-
string
ID progetto o nome del progetto
- top
-
number
Numero massimo di modifiche da restituire.
- skip
-
number
Numero di modifiche da ignorare.
Restituisce
Promise<GitCommitChanges>
getCherryPick(string, number, string)
Recuperare informazioni su un'operazione di selezione ciliegia in base all'ID selezione ciliegia.
function getCherryPick(project: string, cherryPickId: number, repositoryId: string): Promise<GitCherryPick>
Parametri
- project
-
string
ID progetto o nome del progetto
- cherryPickId
-
number
ID della selezione ciliegia.
- repositoryId
-
string
ID del repository.
Restituisce
Promise<GitCherryPick>
getCherryPickConflict(string, number, number, string)
Recuperare un conflitto per una selezione di ciliegia in base all'ID
function getCherryPickConflict(repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>
Parametri
- repositoryId
-
string
- cherryPickId
-
number
- conflictId
-
number
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitConflict>
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)
Recuperare tutti i conflitti per un'opzione cherry pick
function getCherryPickConflicts(repositoryId: string, cherryPickId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>
Parametri
- repositoryId
-
string
- cherryPickId
-
number
- project
-
string
ID progetto o nome del progetto
- continuationToken
-
string
- top
-
number
- excludeResolved
-
boolean
- onlyResolved
-
boolean
- includeObsolete
-
boolean
Restituisce
Promise<PagedList<GitConflict>>
getCherryPickForRefName(string, string, string)
Recuperare informazioni su un'operazione cherry pick per un ramo specifico. Questa operazione è costosa a causa della struttura dell'oggetto sottostante, quindi questa API esamina solo le 1000 operazioni di selezione ciliegie più recenti.
function getCherryPickForRefName(project: string, repositoryId: string, refName: string): Promise<GitCherryPick>
Parametri
- project
-
string
ID progetto o nome del progetto
- repositoryId
-
string
ID del repository.
- refName
-
string
GitAsyncRefOperationParameters generatedRefName usato per l'operazione cherry pick.
Restituisce
Promise<GitCherryPick>
getCherryPickRelationships(string, string, string, boolean)
Dato un commitId, restituisce un elenco di commit che si trovano nella stessa famiglia cherry-pick.
function getCherryPickRelationships(repositoryNameOrId: string, commitId: string, project?: string, includeLinks?: boolean): Promise<GitCommitRef[]>
Parametri
- repositoryNameOrId
-
string
- commitId
-
string
- project
-
string
ID progetto o nome del progetto
- includeLinks
-
boolean
Restituisce
Promise<GitCommitRef[]>
getComment(string, number, number, number, string)
Recuperare un commento associato a un thread specifico in una richiesta pull.
function getComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread in cui si trova il commento desiderato.
- commentId
-
number
ID del commento.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<Comment>
getComments(string, number, number, string)
Recuperare tutti i commenti associati a un thread specifico in una richiesta pull.
function getComments(repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<Comment[]>
getCommit(string, string, string, number)
Recuperare un determinato commit.
function getCommit(commitId: string, repositoryId: string, project?: string, changeCount?: number): Promise<GitCommit>
Parametri
- commitId
-
string
ID del commit.
- repositoryId
-
string
ID o nome descrittivo del repository. Per usare il nome descrittivo, è necessario specificare anche projectId.
- project
-
string
ID progetto o nome del progetto
- changeCount
-
number
Numero di modifiche da includere nel risultato.
Restituisce
Promise<GitCommit>
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)
Trovare il commit comune più vicino (base di merge) tra i commit di base e di destinazione e ottenere il diff tra i commit di base e di destinazione o i commit comuni e di destinazione.
function getCommitDiffs(repositoryId: string, project?: string, diffCommonCommit?: boolean, top?: number, skip?: number, baseVersionDescriptor?: GitBaseVersionDescriptor, targetVersionDescriptor?: GitTargetVersionDescriptor): Promise<GitCommitDiffs>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- diffCommonCommit
-
boolean
Se true, diff tra commit comuni e di destinazione. Se false, diff tra commit di base e di destinazione.
- top
-
number
Numero massimo di modifiche da restituire. Il valore predefinito è 100.
- skip
-
number
Numero di modifiche da ignorare
- baseVersionDescriptor
- GitBaseVersionDescriptor
Descrittore per il commit di base.
- targetVersionDescriptor
- GitTargetVersionDescriptor
Descrittore per il commit di destinazione.
Restituisce
Promise<GitCommitDiffs>
getCommits(string, GitQueryCommitsCriteria, string)
Recuperare i commit Git per un progetto
function getCommits(repositoryId: string, searchCriteria: GitQueryCommitsCriteria, project?: string): Promise<GitCommitRef[]>
Parametri
- repositoryId
-
string
ID o nome descrittivo del repository. Per usare il nome descrittivo, è necessario specificare anche projectId.
- searchCriteria
- GitQueryCommitsCriteria
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitCommitRef[]>
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)
Recuperare i commit Git per un progetto che corrisponde ai criteri di ricerca
function getCommitsBatch(searchCriteria: GitQueryCommitsCriteria, repositoryId: string, project?: string, skip?: number, top?: number, includeStatuses?: boolean): Promise<GitCommitRef[]>
Parametri
- searchCriteria
- GitQueryCommitsCriteria
Opzioni di ricerca
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- skip
-
number
Numero di commit da ignorare. Il valore non può superare 3.000.000.
- top
-
number
Numero massimo di commit da restituire. Il valore non può superare 50.000.
- includeStatuses
-
boolean
True per includere informazioni aggiuntive sullo stato del commit.
Restituisce
Promise<GitCommitRef[]>
getDeletedRepositories(string)
Recuperare i repository Git eliminati.
function getDeletedRepositories(project: string): Promise<GitDeletedRepository[]>
Parametri
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitDeletedRepository[]>
getEnablementStatus(string[], Date, number, number)
GET Stato di abilitazione per i repository del progetto.
function getEnablementStatus(projectIds?: string[], billingDate?: Date, skip?: number, take?: number): Promise<AdvSecEnablementStatus[]>
Parametri
- projectIds
-
string[]
Il valore predefinito Null è per tutti i progetti nell'host, elenco dello stato dei repository del progetto da restituire
- billingDate
-
Date
Previsto UTC, il valore predefinito Null è UtcNow(), può essere fornito per uno stato temporizzato
- skip
-
number
Ignorare le righe X del set di risultati per simulare il paging.
- take
-
number
Restituire righe Y del set di risultati per simulare il paging.
Restituisce
Promise<AdvSecEnablementStatus[]>
getEnableOnCreateHost(boolean)
function getEnableOnCreateHost(enableOnCreateHost: boolean): Promise<boolean>
Parametri
- enableOnCreateHost
-
boolean
Restituisce
Promise<boolean>
getEnableOnCreateProject(string)
function getEnableOnCreateProject(enableOnCreateProjectId: string): Promise<boolean>
Parametri
- enableOnCreateProjectId
-
string
Restituisce
Promise<boolean>
getEstimatedBillableCommittersRepo(string, string)
Ottenere i commit fatturabili stimati per un repository per gli ultimi 90 giorni.
function getEstimatedBillableCommittersRepo(project: string, repositoryId: string): Promise<BillableCommitter[]>
Parametri
- project
-
string
ID progetto o nome del progetto
- repositoryId
-
string
Restituisce
Promise<BillableCommitter[]>
getEstimatedBillablePushersOrg()
Ottenere i push fatturabili stimati per un'organizzazione per gli ultimi 90 giorni.
function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>
Restituisce
Promise<BillablePusher[]>
getEstimatedBillablePushersProject(string)
Ottenere push fatturabili stimati per un progetto per gli ultimi 90 giorni.
function getEstimatedBillablePushersProject(project: string): Promise<BillablePusher[]>
Parametri
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<BillablePusher[]>
getFileDiffs(FileDiffsCriteria, string, string)
Ottenere le differenze di file per ognuno dei file specificati
function getFileDiffs(fileDiffsCriteria: FileDiffsCriteria, project: string, repositoryId: string): Promise<FileDiff[]>
Parametri
- fileDiffsCriteria
- FileDiffsCriteria
Elenco di oggetti parametri di file
- project
-
string
ID progetto o nome del progetto
- repositoryId
-
string
Nome o ID del repository
Restituisce
Promise<FileDiff[]>
getForks(string, string, string, boolean)
Recuperare tutti i fork di un repository nella raccolta.
function getForks(repositoryNameOrId: string, collectionId: string, project?: string, includeLinks?: boolean): Promise<GitRepositoryRef[]>
Parametri
- repositoryNameOrId
-
string
Nome o ID del repository.
- collectionId
-
string
ID raccolta progetto team.
- project
-
string
ID progetto o nome del progetto
- includeLinks
-
boolean
True per includere collegamenti.
Restituisce
Promise<GitRepositoryRef[]>
getForkSyncRequest(string, number, string, boolean)
Ottenere i dettagli di un'operazione di sincronizzazione fork specifica.
function getForkSyncRequest(repositoryNameOrId: string, forkSyncOperationId: number, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>
Parametri
- repositoryNameOrId
-
string
Nome o ID del repository.
- forkSyncOperationId
-
number
OperationId della richiesta di sincronizzazione.
- project
-
string
ID progetto o nome del progetto
- includeLinks
-
boolean
True per includere collegamenti.
Restituisce
Promise<GitForkSyncRequest>
getForkSyncRequests(string, string, boolean, boolean)
Recuperare tutte le operazioni di sincronizzazione fork richieste in questo repository.
function getForkSyncRequests(repositoryNameOrId: string, project?: string, includeAbandoned?: boolean, includeLinks?: boolean): Promise<GitForkSyncRequest[]>
Parametri
- repositoryNameOrId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- includeAbandoned
-
boolean
True per includere le richieste abbandonate.
- includeLinks
-
boolean
True per includere collegamenti.
Restituisce
Promise<GitForkSyncRequest[]>
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come 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>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- path
-
string
Percorso dell'elemento.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
- resolveHfs
-
boolean
Impostare su true per risolvere i file del puntatore GIT HFS per restituire il contenuto effettivo da Git HFS. Il valore predefinito è true.
- sanitize
-
boolean
Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
Restituisce
Promise<GitItem>
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download.
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>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- path
-
string
Percorso dell'elemento.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
- resolveHfs
-
boolean
Impostare su true per risolvere i file del puntatore GIT HFS per restituire il contenuto effettivo da Git HFS. Il valore predefinito è true.
- sanitize
-
boolean
Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
Restituisce
Promise<ArrayBuffer>
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)
Ottiene i metadati e/o il contenuto dell'elemento per una raccolta di elementi. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come 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[]>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- includeLinks
-
boolean
Impostare su true per includere collegamenti agli elementi. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- zipForUnix
-
boolean
Impostare su true per mantenere le autorizzazioni per i file per sistemi UNIX (e POSIX) come eseguibili e collegamenti simbolici
Restituisce
Promise<GitItem[]>
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download.
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>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- path
-
string
Percorso dell'elemento.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
- resolveHfs
-
boolean
Impostare su true per risolvere i file del puntatore GIT HFS per restituire il contenuto effettivo da Git HFS. Il valore predefinito è true.
- sanitize
-
boolean
Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
Restituisce
Promise<string>
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download.
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>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- path
-
string
Percorso dell'elemento.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
- resolveHfs
-
boolean
Impostare su true per risolvere i file del puntatore GIT HFS per restituire il contenuto effettivo da Git HFS. Il valore predefinito è true.
- sanitize
-
boolean
Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
Restituisce
Promise<ArrayBuffer>
getImportRequest(string, string, number)
Recuperare una richiesta di importazione specifica.
function getImportRequest(project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>
Parametri
- project
-
string
ID progetto o nome del progetto
- repositoryId
-
string
Nome o ID del repository.
- importRequestId
-
number
Identificatore univoco per la richiesta di importazione.
Restituisce
Promise<GitImportRequest>
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download.
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>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- path
-
string
Percorso dell'elemento.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
- resolveLfs
-
boolean
Impostare su true per risolvere i file del puntatore Git LFS per restituire il contenuto effettivo da Git LFS. L'impostazione predefinita è false.
- sanitize
-
boolean
Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
Restituisce
Promise<GitItem>
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download.
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>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- path
-
string
Percorso dell'elemento.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
- resolveLfs
-
boolean
Impostare su true per risolvere i file del puntatore Git LFS per restituire il contenuto effettivo da Git LFS. L'impostazione predefinita è false.
- sanitize
-
boolean
Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
Restituisce
Promise<ArrayBuffer>
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)
Ottiene i metadati e/o il contenuto dell'elemento per una raccolta di elementi. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso che viene sempre restituito come download.
function getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- includeLinks
-
boolean
Impostare su true per includere collegamenti agli elementi. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- zipForUnix
-
boolean
Impostare su true per mantenere le autorizzazioni per i file per sistemi UNIX (e POSIX) come eseguibili e collegamenti simbolici
Restituisce
Promise<GitItem[]>
getItemsBatch(GitItemRequestData, string, string)
Post per il recupero di una creazione di un batch da un set di elementi in un repository/progetto in base a un elenco di percorsi o a un percorso lungo
function getItemsBatch(requestData: GitItemRequestData, repositoryId: string, project?: string): Promise<GitItem[][]>
Parametri
- requestData
- GitItemRequestData
Attributi dei dati della richiesta: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: raccolta di elementi da recuperare, inclusi il percorso, la versione e il livello di ricorsione. IncludeContentMetadata: indica se includere metadati per tutti gli elementi LatestProcessedChange: indica se includere ref superficiale per eseguire il commit dell'ultimo elemento modificato. IncludeLinks: indica se includere il campo _links sui riferimenti superficiali.
- repositoryId
-
string
Nome o ID del repository
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitItem[][]>
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download.
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>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- path
-
string
Percorso dell'elemento.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
- resolveLfs
-
boolean
Impostare su true per risolvere i file del puntatore Git LFS per restituire il contenuto effettivo da Git LFS. L'impostazione predefinita è false.
- sanitize
-
boolean
Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
Restituisce
Promise<string>
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)
Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download.
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>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- path
-
string
Percorso dell'elemento.
- project
-
string
ID progetto o nome del progetto
- scopePath
-
string
Ambito del percorso. Il valore predefinito è Null.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
- includeContentMetadata
-
boolean
Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
- latestProcessedChange
-
boolean
Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
- download
-
boolean
Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
- versionDescriptor
- GitVersionDescriptor
Descrittore di versione. Il valore predefinito è il ramo predefinito per il repository.
- includeContent
-
boolean
Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
- resolveLfs
-
boolean
Impostare su true per risolvere i file del puntatore Git LFS per restituire il contenuto effettivo da Git LFS. L'impostazione predefinita è false.
- sanitize
-
boolean
Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
Restituisce
Promise<ArrayBuffer>
getLikes(string, number, number, number, string)
Ottieni mi piace per un commento.
function getLikes(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<IdentityRef[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread che contiene il commento.
- commentId
-
number
ID del commento.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<IdentityRef[]>
getMergeBases(string, string, string, string, string, string)
Trovare le basi di merge di due commit, facoltativamente tra fork. Se non viene specificato otherRepositoryId, le basi di merge verranno calcolate solo nel contesto del repository localeNameOrId.
function getMergeBases(repositoryNameOrId: string, commitId: string, otherCommitId: string, project?: string, otherCollectionId?: string, otherRepositoryId?: string): Promise<GitCommitRef[]>
Parametri
- repositoryNameOrId
-
string
ID o nome del repository locale.
- commitId
-
string
Primo commit, in genere il suggerimento del ramo di destinazione del potenziale merge.
- otherCommitId
-
string
Altro commit, in genere il suggerimento del ramo di origine del potenziale merge.
- project
-
string
ID progetto o nome del progetto
- otherCollectionId
-
string
ID raccolta in cui risiede otherCommitId.
- otherRepositoryId
-
string
ID del repository in cui si trova otherCommitId.
Restituisce
Promise<GitCommitRef[]>
getMergeRequest(string, string, number, boolean)
Ottenere i dettagli di un'operazione di merge specifica.
function getMergeRequest(project: string, repositoryNameOrId: string, mergeOperationId: number, includeLinks?: boolean): Promise<GitMerge>
Parametri
- project
-
string
ID progetto o nome del progetto
- repositoryNameOrId
-
string
Nome o ID del repository.
- mergeOperationId
-
number
OperationId della richiesta di merge.
- includeLinks
-
boolean
True per includere i collegamenti
Restituisce
Promise<GitMerge>
getPermission(string, string, string)
Get Advanced Security Permission status (Stato dell'autorizzazione di sicurezza avanzata GET).
function getPermission(projectName?: string, repositoryId?: string, permission?: string): Promise<boolean>
Parametri
- projectName
-
string
- repositoryId
-
string
L'utente del repository sta tentando di accedere
- permission
-
string
L'autorizzazione richiesta deve essere "viewAlert" "dismissAlert" "manage" "viewEnablement" o "repoRead"
Restituisce
Promise<boolean>
getPullRequest(string, number, string, number, number, number, boolean, boolean)
Recuperare una richiesta pull.
function getPullRequest(repositoryId: string, pullRequestId: number, project?: string, maxCommentLength?: number, skip?: number, top?: number, includeCommits?: boolean, includeWorkItemRefs?: boolean): Promise<GitPullRequest>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull da recuperare.
- project
-
string
ID progetto o nome del progetto
- maxCommentLength
-
number
Non usato.
- skip
-
number
Non usato.
- top
-
number
Non usato.
- includeCommits
-
boolean
Se true, la richiesta pull verrà restituita con i commit associati.
- includeWorkItemRefs
-
boolean
Se true, la richiesta pull verrà restituita con i riferimenti all'elemento di lavoro associato.
Restituisce
Promise<GitPullRequest>
getPullRequestById(number, string)
Recuperare una richiesta pull.
function getPullRequestById(pullRequestId: number, project?: string): Promise<GitPullRequest>
Parametri
- pullRequestId
-
number
ID della richiesta pull da recuperare.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequest>
getPullRequestCommits(string, number, string)
Ottenere i commit per la richiesta pull specificata.
function getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<PagedList<GitCommitRef>>
Parametri
- repositoryId
-
string
ID o nome del repository.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<PagedList<GitCommitRef>>
getPullRequestConflict(string, number, number, string)
Recuperare un conflitto per una richiesta pull in base all'ID
function getPullRequestConflict(repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>
Parametri
- repositoryId
-
string
- pullRequestId
-
number
- conflictId
-
number
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitConflict>
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)
Recuperare tutti i conflitti per una richiesta pull
function getPullRequestConflicts(repositoryId: string, pullRequestId: number, project?: string, skip?: number, top?: number, includeObsolete?: boolean, excludeResolved?: boolean, onlyResolved?: boolean): Promise<GitConflict[]>
Parametri
- repositoryId
-
string
Repository della richiesta pull.
- pullRequestId
-
number
ID richiesta pull.
- project
-
string
ID progetto o nome del progetto
- skip
-
number
Conflitti da ignorare.
- top
-
number
Conflitti da restituire dopo il passaggio.
- includeObsolete
-
boolean
Include conflitti obsoleti.
- excludeResolved
-
boolean
Esclude i conflitti già risolti.
- onlyResolved
-
boolean
Restituisce solo i conflitti risolti.
Restituisce
Promise<GitConflict[]>
getPullRequestIteration(string, number, number, string)
Ottenere l'iterazione specificata per una richiesta pull.
function getPullRequestIteration(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestIteration>
Parametri
- repositoryId
-
string
ID o nome del repository.
- pullRequestId
-
number
ID della richiesta pull.
- iterationId
-
number
ID dell'iterazione della richiesta pull da restituire.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequestIteration>
getPullRequestIterationChanges(string, number, number, string, number, number, number)
Recuperare le modifiche apportate in una richiesta pull tra due iterazioni.
function getPullRequestIterationChanges(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number, compareTo?: number): Promise<GitPullRequestIterationChanges>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- iterationId
-
number
ID dell'iterazione della richiesta pull. <br/> Iteration uno è l'head del ramo di origine al momento della creazione della richiesta pull e le iterazioni successive vengono create quando sono presenti push nel ramo di origine. I valori consentiti sono compresi tra 1 e l'iterazione massima per questa richiesta pull.
- project
-
string
ID progetto o nome del progetto
- top
-
number
facoltativo. Numero di modifiche da recuperare. Il valore predefinito è 100 e il valore massimo è 2000.
- skip
-
number
facoltativo. Numero di modifiche da ignorare. Ad esempio, per recuperare le modifiche da 101 a 150, impostare i primi 50 e passare a 100.
- compareTo
-
number
ID dell'iterazione della richiesta pull da confrontare. Il valore predefinito è zero che indica che il confronto viene eseguito con il commit comune tra i rami di origine e di destinazione
Restituisce
Promise<GitPullRequestIterationChanges>
getPullRequestIterationCommits(string, number, number, string, number, number)
Ottenere i commit per l'iterazione specificata di una richiesta pull.
function getPullRequestIterationCommits(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number): Promise<GitCommitRef[]>
Parametri
- repositoryId
-
string
ID o nome del repository.
- pullRequestId
-
number
ID della richiesta pull.
- iterationId
-
number
ID dell'iterazione da cui ottenere i commit.
- project
-
string
ID progetto o nome del progetto
- top
-
number
Numero massimo di commit da restituire. Il numero massimo di commit che è possibile restituire per batch è 500.
- skip
-
number
Numero di commit da ignorare.
Restituisce
Promise<GitCommitRef[]>
getPullRequestIterations(string, number, string, boolean)
Ottenere l'elenco di iterazioni per la richiesta pull specificata.
function getPullRequestIterations(repositoryId: string, pullRequestId: number, project?: string, includeCommits?: boolean): Promise<GitPullRequestIteration[]>
Parametri
- repositoryId
-
string
ID o nome del repository.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
- includeCommits
-
boolean
Se true, includere i commit associati a ogni iterazione nella risposta.
Restituisce
Promise<GitPullRequestIteration[]>
getPullRequestIterationStatus(string, number, number, number, string)
Ottenere lo stato di iterazione della richiesta pull specifico in base all'ID. L'ID di stato è univoco all'interno della richiesta pull in tutte le iterazioni.
function getPullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- iterationId
-
number
ID dell'iterazione della richiesta pull.
- statusId
-
number
ID dello stato della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequestStatus>
getPullRequestIterationStatuses(string, number, number, string)
Ottenere tutti gli stati associati a un'iterazione della richiesta pull.
function getPullRequestIterationStatuses(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- iterationId
-
number
ID dell'iterazione della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequestStatus[]>
getPullRequestLabel(string, number, string, string, string)
Recupera una singola etichetta (tag) assegnata a una richiesta pull.
function getPullRequestLabel(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<WebApiTagDefinition>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- labelIdOrName
-
string
Nome o ID dell'etichetta richiesta.
- project
-
string
ID progetto o nome del progetto
- projectId
-
string
ID progetto o nome del progetto.
Restituisce
Promise<WebApiTagDefinition>
getPullRequestLabels(string, number, string, string)
Ottenere tutte le etichette (tag) assegnate a una richiesta pull.
function getPullRequestLabels(repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
- projectId
-
string
ID progetto o nome del progetto.
Restituisce
Promise<WebApiTagDefinition[]>
getPullRequestProperties(string, number, string)
Ottiene le proprietà esterne della richiesta pull.
function getPullRequestProperties(repositoryId: string, pullRequestId: number, project?: string): Promise<any>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<any>
getPullRequestQuery(GitPullRequestQuery, string, string)
Questa API viene usata per trovare le richieste pull correlate a un determinato commit. Può essere usato per trovare la richiesta pull che ha creato un commit di merge specifico oppure può essere usata per trovare tutte le richieste pull che hanno mai unito un determinato commit. L'input è un elenco di query che contengono un elenco di commit. Per ogni commit su cui si esegue la ricerca, si otterrà un dizionario di commit-> richieste pull.
function getPullRequestQuery(queries: GitPullRequestQuery, repositoryId: string, project?: string): Promise<GitPullRequestQuery>
Parametri
- queries
- GitPullRequestQuery
Elenco di query da eseguire.
- repositoryId
-
string
ID del repository.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequestQuery>
getPullRequestReviewer(string, number, string, string)
Recuperare informazioni su un determinato revisore in una richiesta pull
function getPullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- reviewerId
-
string
ID del revisore.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<IdentityRefWithVote>
getPullRequestReviewers(string, number, string)
Recuperare i revisori per una richiesta pull
function getPullRequestReviewers(repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<IdentityRefWithVote[]>
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)
Recuperare tutte le richieste pull corrispondenti a un criterio specificato.
function getPullRequests(repositoryId: string, searchCriteria: GitPullRequestSearchCriteria, project?: string, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- searchCriteria
- GitPullRequestSearchCriteria
Le richieste pull verranno restituite che corrispondono a questi criteri di ricerca.
- project
-
string
ID progetto o nome progetto
- maxCommentLength
-
number
Non usato.
- skip
-
number
Numero di richieste pull da ignorare. Ad esempio, per recuperare i risultati 101-150, impostare top su 50 e passare a 100.
- top
-
number
Numero di richieste pull da recuperare.
Restituisce
Promise<GitPullRequest[]>
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)
Recuperare tutte le richieste pull corrispondenti a criteri specificati.
function getPullRequestsByProject(project: string, searchCriteria: GitPullRequestSearchCriteria, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>
Parametri
- project
-
string
ID progetto o nome progetto
- searchCriteria
- GitPullRequestSearchCriteria
Le richieste pull verranno restituite che corrispondono a questi criteri di ricerca.
- maxCommentLength
-
number
Non usato.
- skip
-
number
Numero di richieste pull da ignorare. Ad esempio, per recuperare i risultati 101-150, impostare top su 50 e passare a 100.
- top
-
number
Numero di richieste pull da recuperare.
Restituisce
Promise<GitPullRequest[]>
getPullRequestStatus(string, number, number, string)
Ottenere lo stato della richiesta pull specifica in base all'ID. L'ID di stato è univoco all'interno della richiesta pull in tutte le iterazioni.
function getPullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- statusId
-
number
ID dello stato della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitPullRequestStatus>
getPullRequestStatuses(string, number, string)
Ottenere tutti gli stati associati a una richiesta pull.
function getPullRequestStatuses(repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitPullRequestStatus[]>
getPullRequestThread(string, number, number, string, number, number)
Recuperare un thread in una richiesta pull.
function getPullRequestThread(repositoryId: string, pullRequestId: number, threadId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread.
- project
-
string
ID progetto o nome progetto
- iteration
-
number
Se specificato, la posizione del thread verrà tracciata usando questa iterazione come lato destro del diff.
- baseIteration
-
number
Se specificato, la posizione del thread verrà rilevata usando questa iterazione come lato sinistro della diff.
Restituisce
Promise<GitPullRequestCommentThread>
getPullRequestWorkItemRefs(string, number, string)
Recuperare un elenco di elementi di lavoro associati a una richiesta pull.
function getPullRequestWorkItemRefs(repositoryId: string, pullRequestId: number, project?: string): Promise<ResourceRef[]>
Parametri
- repositoryId
-
string
ID o nome del repository.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ResourceRef[]>
getPush(string, number, string, number, boolean)
Recupera un push specifico.
function getPush(repositoryId: string, pushId: number, project?: string, includeCommits?: number, includeRefUpdates?: boolean): Promise<GitPush>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- pushId
-
number
ID del push.
- project
-
string
ID progetto o nome progetto
- includeCommits
-
number
Numero di commit da includere nel risultato.
- includeRefUpdates
-
boolean
Se true, includere l'elenco di ref aggiornati dal push.
Restituisce
Promise<GitPush>
getPushCommits(string, number, string, number, number, boolean)
Recuperare un elenco di commit associati a un push specifico.
function getPushCommits(repositoryId: string, pushId: number, project?: string, top?: number, skip?: number, includeLinks?: boolean): Promise<GitCommitRef[]>
Parametri
- repositoryId
-
string
ID o nome descrittivo del repository. Per usare il nome descrittivo, è necessario specificare projectId.
- pushId
-
number
ID del push.
- project
-
string
ID progetto o nome progetto
- top
-
number
Numero massimo di commit da restituire ("ottenere i primi commit x").
- skip
-
number
Numero di commit da ignorare.
- includeLinks
-
boolean
Impostare su false per evitare l'inclusione dei collegamenti url REST per le risorse. Viene impostato come predefinito true.
Restituisce
Promise<GitCommitRef[]>
getPushes(string, string, number, number, GitPushSearchCriteria)
Recupera i push associati al repository specificato.
function getPushes(repositoryId: string, project?: string, skip?: number, top?: number, searchCriteria?: GitPushSearchCriteria): Promise<GitPush[]>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome progetto
- skip
-
number
Numero di push da ignorare.
- top
-
number
Numero di push da restituire.
- searchCriteria
- GitPushSearchCriteria
Attributi dei criteri di ricerca: fromDate, toDate, pusherId, refName, includeRefUpdates o includeLinks. fromDate: data di inizio da cui eseguire la ricerca. toDate: data di fine da cercare. pusherId: identità della persona che ha inviato il push. refName: nome del ramo da considerare. includeRefUpdates: se true, includere l'elenco di ref aggiornati dal push. includeLinks: indica se includere il campo _links sui riferimenti superficiali.
Restituisce
Promise<GitPush[]>
getRecycleBinRepositories(string)
Recuperare i repository Git eliminati in modo leggero dal cestino.
function getRecycleBinRepositories(project: string): Promise<GitDeletedRepository[]>
Parametri
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitDeletedRepository[]>
getRefFavorite(string, number)
Ottiene i valori preferiti per un ID preferito.
function getRefFavorite(project: string, favoriteId: number): Promise<GitRefFavorite>
Parametri
- project
-
string
ID progetto o nome progetto
- favoriteId
-
number
ID del preferito ref richiesto.
Restituisce
Promise<GitRefFavorite>
getRefFavorites(string, string, string)
Ottiene i preferiti di riferimento per un repository e un'identità.
function getRefFavorites(project: string, repositoryId?: string, identityId?: string): Promise<GitRefFavorite[]>
Parametri
- project
-
string
ID progetto o nome progetto
- repositoryId
-
string
ID del repository.
- identityId
-
string
ID dell'identità i cui preferiti devono essere recuperati. Se null, viene usata l'identità richiesta.
Restituisce
Promise<GitRefFavorite[]>
getRefFavoritesForProject(string, string)
function getRefFavoritesForProject(project: string, identityId?: string): Promise<GitRefFavorite[]>
Parametri
- project
-
string
ID progetto o nome progetto
- identityId
-
string
Restituisce
Promise<GitRefFavorite[]>
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)
Esegue query sul repository fornito per i relativi ref e li restituisce.
function getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string): Promise<PagedList<GitRef>>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome progetto
- filter
-
string
[facoltativo] Filtro da applicare ai ref (inizia con).
- includeLinks
-
boolean
[facoltativo] Specifica se i riferimentiLink devono essere inclusi nel risultato. il valore predefinito è false.
- includeStatuses
-
boolean
[facoltativo] Include fino ai primi 1000 stati di commit per ogni riferimento. Il valore predefinito è false.
- includeMyBranches
-
boolean
[facoltativo] Include solo rami proprietari dell'utente, i rami preferiti dell'utente e il ramo predefinito. Il valore predefinito è false. Impossibile combinare il parametro di filtro.
- latestStatusesOnly
-
boolean
[facoltativo] True per includere solo lo stato del commit del suggerimento per ogni riferimento. Questa opzione deve includeStatuses
essere true. Il valore predefinito è false.
- peelTags
-
boolean
[facoltativo] I tag annotati popolano la proprietà PeeledObjectId. il valore predefinito è false.
- filterContains
-
string
[facoltativo] Filtro da applicare ai ref (contiene).
Restituisce
getRepositories(string, boolean, boolean, boolean)
Recuperare i repository git.
function getRepositories(project?: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean): Promise<GitRepository[]>
Parametri
- project
-
string
ID progetto o nome progetto
- includeLinks
-
boolean
[facoltativo] True per includere collegamenti di riferimento. Il valore predefinito è false.
- includeAllUrls
-
boolean
[facoltativo] True per includere tutti gli URL remoti. Il valore predefinito è false.
- includeHidden
-
boolean
[facoltativo] True per includere repository nascosti. Il valore predefinito è false.
Restituisce
Promise<GitRepository[]>
getRepository(string, string)
Recuperare un repository git.
function getRepository(repositoryId: string, project?: string): Promise<GitRepository>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitRepository>
getRepositoryWithParent(string, boolean, string)
Recuperare un repository git.
function getRepositoryWithParent(repositoryId: string, includeParent: boolean, project?: string): Promise<GitRepository>
Parametri
- repositoryId
-
string
Nome o ID del repository.
- includeParent
-
boolean
True per includere il repository padre. Disponibile solo nelle chiamate autenticate.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitRepository>
getRevert(string, number, string)
Recuperare informazioni su un'operazione di ripristino ripristinando l'ID.
function getRevert(project: string, revertId: number, repositoryId: string): Promise<GitRevert>
Parametri
- project
-
string
ID progetto o nome progetto
- revertId
-
number
ID dell'operazione di ripristino.
- repositoryId
-
string
ID del repository.
Restituisce
Promise<GitRevert>
getRevertConflict(string, number, number, string)
Recuperare un conflitto per un revert by ID
function getRevertConflict(repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>
Parametri
- repositoryId
-
string
- revertId
-
number
- conflictId
-
number
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitConflict>
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)
Recuperare tutti i conflitti per un ripristino
function getRevertConflicts(repositoryId: string, revertId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>
Parametri
- repositoryId
-
string
- revertId
-
number
- project
-
string
ID progetto o nome progetto
- continuationToken
-
string
- top
-
number
- excludeResolved
-
boolean
- onlyResolved
-
boolean
- includeObsolete
-
boolean
Restituisce
Promise<PagedList<GitConflict>>
getRevertForRefName(string, string, string)
Recuperare informazioni su un'operazione di ripristino per un ramo specifico.
function getRevertForRefName(project: string, repositoryId: string, refName: string): Promise<GitRevert>
Parametri
- project
-
string
ID progetto o nome progetto
- repositoryId
-
string
ID del repository.
- refName
-
string
GitAsyncRefOperationParameters generatodRefName usato per l'operazione di ripristino.
Restituisce
Promise<GitRevert>
getStatuses(string, string, string, number, number, boolean)
Ottenere gli stati associati al commit Git.
function getStatuses(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number, latestOnly?: boolean): Promise<GitStatus[]>
Parametri
- commitId
-
string
ID del commit Git.
- repositoryId
-
string
ID del repository.
- project
-
string
ID progetto o nome progetto
- top
-
number
facoltativo. Numero di stati da recuperare. Il valore predefinito è 1000.
- skip
-
number
facoltativo. Numero di stati da ignorare. Il valore predefinito è 0. Ad esempio, per recuperare i risultati 101-150, impostare top su 50 e passare a 100.
- latestOnly
-
boolean
Il flag indica se ottenere solo gli stati più recenti raggruppati per Context.Name
e Context.Genre
.
Restituisce
Promise<GitStatus[]>
getSuggestions(string, string, boolean)
Recuperare un suggerimento di richiesta pull per un determinato repository o progetto team.
function getSuggestions(repositoryId: string, project?: string, preferCompareBranch?: boolean): Promise<GitSuggestion[]>
Parametri
- repositoryId
-
string
ID del repository Git.
- project
-
string
ID progetto o nome progetto
- preferCompareBranch
-
boolean
Se true, preferisce il ramo di confronto sul ramo predefinito come ramo di destinazione per le richieste pull.
Restituisce
Promise<GitSuggestion[]>
getThreads(string, number, string, number, number)
Recuperare tutti i thread in una richiesta pull.
function getThreads(repositoryId: string, pullRequestId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread[]>
Parametri
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
- iteration
-
number
Se specificato, le posizioni del thread verranno rilevate usando questa iterazione come lato destro del diff.
- baseIteration
-
number
Se specificato, le posizioni del thread verranno rilevate usando questa iterazione come lato sinistro della diff.
Restituisce
Promise<GitPullRequestCommentThread[]>
getTree(string, string, string, string, boolean, string)
L'endpoint Tree restituisce la raccolta di oggetti sotto l'albero specificato. Gli alberi sono cartelle in un repository Git.
function getTree(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<GitTreeRef>
Parametri
- repositoryId
-
string
ID repository.
- sha1
-
string
HASH SHA1 dell'oggetto albero.
- project
-
string
ID progetto o nome progetto
- projectId
-
string
ID progetto.
- recursive
-
boolean
Cercare in modo ricorsivo. Includere alberi sotto questo albero. L'impostazione predefinita è false.
- fileName
-
string
Nome da usare se viene restituito un file di .zip. Il valore predefinito è l'ID oggetto.
Restituisce
Promise<GitTreeRef>
getTreeZip(string, string, string, string, boolean, string)
L'endpoint Tree restituisce la raccolta di oggetti sotto l'albero specificato. Gli alberi sono cartelle in un repository Git.
function getTreeZip(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<ArrayBuffer>
Parametri
- repositoryId
-
string
ID repository.
- sha1
-
string
HASH SHA1 dell'oggetto albero.
- project
-
string
ID progetto o nome progetto
- projectId
-
string
ID progetto.
- recursive
-
boolean
Cercare in modo ricorsivo. Includere alberi sotto questo albero. L'impostazione predefinita è false.
- fileName
-
string
Nome da usare se viene restituito un file di .zip. Il valore predefinito è l'ID oggetto.
Restituisce
Promise<ArrayBuffer>
queryImportRequests(string, string, boolean)
Recuperare le richieste di importazione per un repository.
function queryImportRequests(project: string, repositoryId: string, includeAbandoned?: boolean): Promise<GitImportRequest[]>
Parametri
- project
-
string
ID progetto o nome progetto
- repositoryId
-
string
Nome o ID del repository.
- includeAbandoned
-
boolean
True per includere le richieste di importazione abbandonate nei risultati.
Restituisce
Promise<GitImportRequest[]>
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)
Ripristinare un repository Git eliminato in modo temporaneo. I repository eliminati di recente entrano in uno stato di eliminazione temporanea per un periodo di tempo prima che vengano eliminati e diventino non recuperabili.
function restoreRepositoryFromRecycleBin(repositoryDetails: GitRecycleBinRepositoryDetails, project: string, repositoryId: string): Promise<GitRepository>
Parametri
- repositoryDetails
- GitRecycleBinRepositoryDetails
- project
-
string
ID progetto o nome progetto
- repositoryId
-
string
ID del repository.
Restituisce
Promise<GitRepository>
setEnableOnCreateHost(boolean)
function setEnableOnCreateHost(enableOnCreateHost: boolean): Promise<void>
Parametri
- enableOnCreateHost
-
boolean
Restituisce
Promise<void>
setEnableOnCreateProject(string, boolean)
function setEnableOnCreateProject(enableOnCreateProjectId: string, enableOnStatus: boolean): Promise<void>
Parametri
- enableOnCreateProjectId
-
string
- enableOnStatus
-
boolean
Restituisce
Promise<void>
sharePullRequest(ShareNotificationContext, string, number, string)
Invia una notifica di posta elettronica su una richiesta pull specifica a un set di destinatari
function sharePullRequest(userMessage: ShareNotificationContext, repositoryId: string, pullRequestId: number, project?: string): Promise<void>
Parametri
- userMessage
- ShareNotificationContext
- repositoryId
-
string
ID del repository Git.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
updateCherryPickConflict(GitConflict, string, number, number, string)
Aggiornare la risoluzione dei conflitti di unione
function updateCherryPickConflict(conflict: GitConflict, repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>
Parametri
- conflict
- GitConflict
- repositoryId
-
string
- cherryPickId
-
number
- conflictId
-
number
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitConflict>
updateCherryPickConflicts(GitConflict[], string, number, string)
Aggiornare più risoluzioni dei conflitti di tipo merge
function updateCherryPickConflicts(conflictUpdates: GitConflict[], repositoryId: string, cherryPickId: number, project?: string): Promise<GitConflictUpdateResult[]>
Parametri
- conflictUpdates
- repositoryId
-
string
- cherryPickId
-
number
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitConflictUpdateResult[]>
updateComment(Comment, string, number, number, number, string)
Aggiornare un commento associato a un thread specifico in una richiesta pull.
function updateComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>
Parametri
- comment
- Comment
Contenuto del commento che deve essere aggiornato. I commenti possono essere fino a 150.000 caratteri.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread in cui si trova il commento desiderato.
- commentId
-
number
ID del commento da aggiornare.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<Comment>
updateEnablementStatus(AdvSecEnablementUpdate[])
Stato di abilitazione POST per i repository.
function updateEnablementStatus(enablementUpdates: AdvSecEnablementUpdate[]): Promise<void>
Parametri
- enablementUpdates
Restituisce
Promise<void>
updateImportRequest(GitImportRequest, string, string, number)
Riprovare o abbandonare una richiesta di importazione non riuscita.
function updateImportRequest(importRequestToUpdate: GitImportRequest, project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>
Parametri
- importRequestToUpdate
- GitImportRequest
Versione aggiornata della richiesta di importazione. Attualmente, l'unica modifica consentita è impostare lo stato su Accodato o Abbandonato.
- project
-
string
ID progetto o nome progetto
- repositoryId
-
string
Nome o ID del repository.
- importRequestId
-
number
Identificatore univoco per la richiesta di importazione da aggiornare.
Restituisce
Promise<GitImportRequest>
updatePullRequest(GitPullRequest, string, number, string)
Aggiornare una richiesta pull
function updatePullRequest(gitPullRequestToUpdate: GitPullRequest, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequest>
Parametri
- gitPullRequestToUpdate
- GitPullRequest
Contenuto della richiesta pull che deve essere aggiornato.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull da aggiornare.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitPullRequest>
updatePullRequestConflict(GitConflict, string, number, number, string)
Aggiornare la risoluzione dei conflitti di unione
function updatePullRequestConflict(conflict: GitConflict, repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>
Parametri
- conflict
- GitConflict
- repositoryId
-
string
- pullRequestId
-
number
- conflictId
-
number
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitConflict>
updatePullRequestConflicts(GitConflict[], string, number, string)
Aggiornare più risoluzioni dei conflitti di tipo merge
function updatePullRequestConflicts(conflictUpdates: GitConflict[], repositoryId: string, pullRequestId: number, project?: string): Promise<GitConflictUpdateResult[]>
Parametri
- conflictUpdates
- repositoryId
-
string
- pullRequestId
-
number
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<GitConflictUpdateResult[]>
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)
Aggiornare la raccolta di stato delle richieste pull. L'unico tipo di operazione supportato è remove
.
function updatePullRequestIterationStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<void>
Parametri
- patchDocument
- JsonPatchDocument
Operazioni da applicare agli stati delle richieste pull in formato PATCH JSON.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- iterationId
-
number
ID dell'iterazione della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<void>
updatePullRequestProperties(JsonPatchDocument, string, number, string)
Creare o aggiornare le proprietà esterne della richiesta pull. L'operazione di patch può essere add
, replace
o remove
. Per add
l'operazione, il percorso può essere vuoto. Se il percorso è vuoto, il valore deve essere un elenco di coppie chiave-valore. Per replace
l'operazione, il percorso non può essere vuoto. Se il percorso non esiste, la proprietà verrà aggiunta all'insieme. Per remove
l'operazione, il percorso non può essere vuoto. Se il percorso non esiste, non verrà eseguita alcuna azione.
function updatePullRequestProperties(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<any>
Parametri
- patchDocument
- JsonPatchDocument
Proprietà da aggiungere, sostituire o rimuovere in formato patch JSON.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<any>
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)
Modificare una voce di revisore. Questi campi sono patchable: isFlagged, hasDeclined
function updatePullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>
Parametri
- reviewer
- IdentityRefWithVote
Dati del revisore.<br />If l'ID del revisore è incluso qui, deve corrispondere al parametro reviewerID.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- reviewerId
-
string
ID del revisore.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<IdentityRefWithVote>
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)
Reimpostare i voti di più revisori in una richiesta pull. NOTA: questo endpoint supporta solo l'aggiornamento dei voti, ma non supporta l'aggiornamento dei revisori richiesti (usare i criteri) o i nomi visualizzati.
function updatePullRequestReviewers(patchVotes: IdentityRefWithVote[], repositoryId: string, pullRequestId: number, project?: string): Promise<void>
Parametri
- patchVotes
ID dei revisori i cui voti verranno reimpostati su zero
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<void>
updatePullRequestStatuses(JsonPatchDocument, string, number, string)
Aggiornare la raccolta degli stati delle richieste pull. L'unico tipo di operazione supportato è remove
.
function updatePullRequestStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<void>
Parametri
- patchDocument
- JsonPatchDocument
Operazioni da applicare agli stati delle richieste pull in formato PATCH JSON.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<void>
updateRef(GitRefUpdate, string, string, string, string)
Bloccare o sbloccare un ramo.
function updateRef(newRefInfo: GitRefUpdate, repositoryId: string, filter: string, project?: string, projectId?: string): Promise<GitRef>
Parametri
- newRefInfo
- GitRefUpdate
Azione di aggiornamento ref (blocco/sblocco) da eseguire
- repositoryId
-
string
Nome o ID del repository.
- filter
-
string
Nome del ramo da bloccare/sbloccare
- project
-
string
ID progetto o nome del progetto
- projectId
-
string
ID o nome del progetto team. Facoltativo se si specifica un ID per il repository.
Restituisce
Promise<GitRef>
updateRefs(GitRefUpdate[], string, string, string)
Creazione, aggiornamento o eliminazione di refs(rami).
function updateRefs(refUpdates: GitRefUpdate[], repositoryId: string, project?: string, projectId?: string): Promise<GitRefUpdateResult[]>
Parametri
- refUpdates
Elenco di aggiornamenti ref per tentare di eseguire
- repositoryId
-
string
Nome o ID del repository.
- project
-
string
ID progetto o nome del progetto
- projectId
-
string
ID o nome del progetto team. Facoltativo se si specifica un ID per il repository.
Restituisce
Promise<GitRefUpdateResult[]>
updateRepository(GitRepository, string, string)
Aggiorna il repository Git con un nuovo nome di repository o un nuovo ramo predefinito.
function updateRepository(newRepositoryInfo: GitRepository, repositoryId: string, project?: string): Promise<GitRepository>
Parametri
- newRepositoryInfo
- GitRepository
Specificare un nuovo nome del repository o un nuovo ramo predefinito del repository
- repositoryId
-
string
ID del repository.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitRepository>
updateRevertConflict(GitConflict, string, number, number, string)
Aggiornare la risoluzione dei conflitti di merge
function updateRevertConflict(conflict: GitConflict, repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>
Parametri
- conflict
- GitConflict
- repositoryId
-
string
- revertId
-
number
- conflictId
-
number
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitConflict>
updateRevertConflicts(GitConflict[], string, number, string)
Aggiornare più risoluzioni dei conflitti di merge
function updateRevertConflicts(conflictUpdates: GitConflict[], repositoryId: string, revertId: number, project?: string): Promise<GitConflictUpdateResult[]>
Parametri
- conflictUpdates
- repositoryId
-
string
- revertId
-
number
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitConflictUpdateResult[]>
updateThread(GitPullRequestCommentThread, string, number, number, string)
Aggiornare un thread in una richiesta pull.
function updateThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<GitPullRequestCommentThread>
Parametri
- commentThread
- GitPullRequestCommentThread
Contenuto del thread da aggiornare.
- repositoryId
-
string
ID repository del ramo di destinazione della richiesta pull.
- pullRequestId
-
number
ID della richiesta pull.
- threadId
-
number
ID del thread da aggiornare.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<GitPullRequestCommentThread>
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per