Pull Requests - Create
Créer une demande de tirage.
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?api-version=7.1-preview.1
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?supportsIterations={supportsIterations}&api-version=7.1-preview.1
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
repository
|
path | True |
string |
ID de dépôt de la branche cible de la demande de tirage. |
project
|
path |
string |
ID de projet ou nom du projet |
|
api-version
|
query | True |
string |
Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API. |
supports
|
query |
boolean |
Si la valeur est true, les envois (push) suivants à la demande de tirage peuvent être examinés individuellement. Définissez cette valeur sur false pour les demandes de tirage volumineuses pour des raisons de performances si cette fonctionnalité n’est pas nécessaire. |
Corps de la demande
Nom | Type | Description |
---|---|---|
_links |
Reference |
Liens vers d’autres objets connexes. |
artifactId |
string |
Chaîne qui identifie de manière unique cette demande de tirage. Pour générer un ID d’artefact pour une demande de tirage, utilisez ce modèle : |
autoCompleteSetBy |
Identity |
Si cette option est définie, la saisie semi-automatique est activée pour cette demande de tirage et il s’agit de l’identité qui l’a activée. |
closedBy |
Identity |
Utilisateur qui a fermé la demande de tirage. |
closedDate |
string |
Date à laquelle la demande de tirage a été fermée (terminée, abandonnée ou fusionnée en externe). |
codeReviewId |
integer |
ID de révision de code de la demande de tirage. Utilisé en interne. |
commits |
Git |
Commits contenus dans la demande de tirage. |
completionOptions |
Git |
Options qui affectent la façon dont la demande de tirage sera fusionnée une fois terminée. |
completionQueueTime |
string |
Date la plus récente à laquelle la demande de tirage est entrée dans la file d’attente à terminer. Utilisé en interne. |
createdBy |
Identity |
Identité de l’utilisateur qui a créé la demande de tirage. |
creationDate |
string |
Date de création de la demande de tirage. |
description |
string |
Description de la demande de tirage. |
forkSource |
Git |
S’il s’agit d’une demande de tirage provenant d’une duplication, elle contient des informations sur sa source. |
hasMultipleMergeBases |
boolean |
Avertissement de plusieurs bases de fusion |
isDraft |
boolean |
Brouillon/demande de tirage WIP. |
labels |
Web |
Étiquettes associées à la demande de tirage. |
lastMergeCommit |
Git |
Validation de la fusion de demande de tirage la plus récente. Si elle est vide, la fusion la plus récente est en cours ou a échoué. |
lastMergeSourceCommit |
Git |
Commit en tête de la branche source au moment de la dernière fusion de la demande de tirage. |
lastMergeTargetCommit |
Git |
Commit en tête de la branche cible au moment de la dernière fusion de la demande de tirage. |
mergeFailureMessage |
string |
Si cette option est définie, la fusion des demandes de tirage a échoué pour cette raison. |
mergeFailureType |
Pull |
Type d’échec (le cas échéant) de la fusion de la demande de tirage. |
mergeId |
string |
ID du travail utilisé pour exécuter la fusion des demandes de tirage. Utilisé en interne. |
mergeOptions |
Git |
Options utilisées lors de l’exécution de la fusion de la demande de tirage. Celles-ci sont distinctes des options d’achèvement, car l’achèvement ne se produit qu’une seule fois et une nouvelle fusion s’exécute chaque fois que la branche source de la demande de tirage change. |
mergeStatus |
Pull |
La status actuelle de la fusion des demandes de tirage. |
pullRequestId |
integer |
ID de la demande de tirage. |
remoteUrl |
string |
Utilisé en interne. |
repository |
Git |
Référentiel contenant la branche cible de la demande de tirage. |
reviewers |
Identity |
Liste des réviseurs sur la demande de tirage ainsi que l’état de leurs votes. |
sourceRefName |
string |
Nom de la branche source de la demande de tirage. |
status |
Pull |
Status de la demande de tirage. |
supportsIterations |
boolean |
Si la valeur est true, cette demande de tirage prend en charge plusieurs itérations. La prise en charge des itérations signifie que les envois (push) individuels vers la branche source de la demande de tirage peuvent être examinés et que les commentaires laissés dans une itération seront suivis dans les itérations futures. |
targetRefName |
string |
Nom de la branche cible de la demande de tirage. |
title |
string |
Titre de la demande de tirage. |
url |
string |
Utilisé en interne. |
workItemRefs |
Resource |
Toutes les références d’élément de travail associées à cette demande de tirage. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Git |
opération réussie |
Sécurité
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Nom | Description |
---|---|
vso.code_write | Permet de lire, de mettre à jour et de supprimer le code source, d’accéder aux métadonnées relatives aux commits, aux ensembles de modifications, aux branches et à d’autres artefacts de contrôle de version. Permet également de créer et de gérer des demandes de tirage et des révisions de code, et de recevoir des notifications sur les événements de contrôle de version via des hooks de service. |
Exemples
Sample Request
POST https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests?api-version=7.1-preview.1
{
"sourceRefName": "refs/heads/npaulk/my_work",
"targetRefName": "refs/heads/new_feature",
"title": "A new feature",
"description": "Adding a new feature",
"reviewers": [
{
"id": "d6245f20-2af8-44f4-9451-8107cb2767db"
}
]
}
Sample Response
{
"repository": {
"id": "3411ebc1-d5aa-464f-9615-0b527bc66719",
"name": "2016_10_31",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719",
"project": {
"id": "a7573007-bbb3-4341-b726-0c4148a07853",
"name": "2016_10_31",
"description": "test project created on Halloween 2016",
"url": "https://dev.azure.com/fabrikam/_apis/projects/a7573007-bbb3-4341-b726-0c4148a07853",
"state": "wellFormed",
"revision": 7
},
"remoteUrl": "https://dev.azure.com/fabrikam/_git/2016_10_31"
},
"pullRequestId": 22,
"codeReviewId": 22,
"status": "active",
"createdBy": {
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
},
"creationDate": "2016-11-01T16:30:31.6655471Z",
"title": "A new feature",
"description": "Adding a new feature",
"sourceRefName": "refs/heads/npaulk/my_work",
"targetRefName": "refs/heads/new_feature",
"mergeStatus": "queued",
"mergeId": "f5fc8381-3fb2-49fe-8a0d-27dcc2d6ef82",
"lastMergeSourceCommit": {
"commitId": "b60280bc6e62e2f880f1b63c1e24987664d3bda3",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/b60280bc6e62e2f880f1b63c1e24987664d3bda3"
},
"lastMergeTargetCommit": {
"commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"reviewers": [
{
"reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db",
"vote": 0,
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
}
],
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22"
},
"repository": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719"
},
"workItems": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/workitems"
},
"sourceBranch": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
},
"targetBranch": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
},
"sourceCommit": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/b60280bc6e62e2f880f1b63c1e24987664d3bda3"
},
"targetCommit": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"createdBy": {
"href": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
},
"iterations": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/iterations"
}
},
"supportsIterations": true,
"artifactId": "vstfs:///Git/PullRequestId/a7573007-bbb3-4341-b726-0c4148a07853%2f3411ebc1-d5aa-464f-9615-0b527bc66719%2f22"
}
Définitions
Nom | Description |
---|---|
Change |
|
Git |
|
Git |
Fournit des propriétés qui décrivent un commit Git et les métadonnées associées. |
Git |
Informations sur une référence fork. |
Git |
Représente toutes les données associées à une demande de tirage. |
Git |
Préférences relatives à la façon dont la demande de tirage doit être effectuée. |
Git |
Options utilisées lors de la création d’une fusion de demande de tirage. |
Git |
Spécifiez la stratégie utilisée pour fusionner la demande de tirage lors de l’achèvement. Si MergeStrategy n’est défini sur aucune valeur, une fusion sans FF est créée si SquashMerge == false. Si MergeStrategy n’est défini sur aucune valeur, les validations de demande de tirage sont écrasées si SquashMerge == true. La propriété SquashMerge est déconseillée. Il est recommandé de définir explicitement MergeStrategy dans tous les cas. Si une valeur explicite est fournie pour MergeStrategy, la propriété SquashMerge est ignorée. |
Git |
|
Git |
|
Git |
|
Git |
Cette classe contient les métadonnées d’un service/d’une extension qui publie un status. |
Git |
Contexte d’état qui identifie de manière unique le status. |
Git |
État du status. |
Git |
|
Git |
Informations utilisateur et date pour les opérations Git. |
Identity |
|
Identity |
Informations d’identité, y compris un vote sur une demande de tirage. |
Item |
|
Item |
|
Project |
État du projet. |
Project |
Visibilité du projet. |
Pull |
La status actuelle de la fusion des demandes de tirage. |
Pull |
Type d’échec (le cas échéant) de la fusion de demande de tirage. |
Pull |
Status de la demande de tirage. |
Reference |
Classe pour représenter une collection de liens de référence REST. |
Resource |
|
Team |
Objet de référence pour un TeamProjectCollection. |
Team |
Représente une référence superficielle à un TeamProject. |
Version |
Type de modification apportée à l’élément. |
Web |
Représentation d’une définition de balise qui est envoyée sur le réseau. |
ChangeCountDictionary
GitChange
Nom | Type | Description |
---|---|---|
changeId |
integer |
ID de la modification dans le groupe de modifications. |
changeType |
Version |
Type de modification apportée à l’élément. |
item |
string |
Version actuelle. |
newContent |
Item |
Contenu de l’élément après la modification. |
newContentTemplate |
Git |
Nouveau modèle de contenu à utiliser lors de l’envoi de nouvelles modifications. |
originalPath |
string |
Chemin d’accès d’origine de l’élément s’il est différent du chemin d’accès actuel. |
sourceServerItem |
string |
Chemin de l’élément sur le serveur. |
url |
string |
URL pour récupérer l’élément. |
GitCommitRef
Fournit des propriétés qui décrivent un commit Git et les métadonnées associées.
Nom | Type | Description |
---|---|---|
_links |
Reference |
Collection de liens de référence REST associés. |
author |
Git |
Auteur de la validation. |
changeCounts |
Change |
Nombre de types de modifications (modifications, suppressions, etc.) inclus dans la validation. |
changes |
Git |
Énumération des modifications incluses dans le commit. |
comment |
string |
Commentaire ou message du commit. |
commentTruncated |
boolean |
Indique si le commentaire est tronqué à partir du message de commentaire de validation Git complet. |
commitId |
string |
ID (SHA-1) du commit. |
commitTooManyChanges |
boolean |
Indique que la validation contient trop de modifications pour être affichées |
committer |
Git |
Commiter du commit. |
parents |
string[] |
Énumération des ID de validation parent pour cette validation. |
push |
Git |
Envoi (push) associé à ce commit. |
remoteUrl |
string |
Chemin d’URL distante du commit. |
statuses |
Git |
Liste des métadonnées status des services et des extensions qui peuvent associer des informations supplémentaires à la validation. |
url |
string |
URL REST pour cette ressource. |
workItems |
Resource |
Liste des éléments de travail associés à cette validation. |
GitForkRef
Informations sur une référence fork.
Nom | Type | Description |
---|---|---|
_links |
Reference |
Classe pour représenter une collection de liens de référence REST. |
creator |
Identity |
|
isLocked |
boolean |
|
isLockedBy |
Identity |
|
name |
string |
|
objectId |
string |
|
peeledObjectId |
string |
|
repository |
Git |
ID de dépôt de la duplication. |
statuses |
Git |
Cette classe contient les métadonnées d’un service/extension qui publie un status. |
url |
string |
GitPullRequest
Représente toutes les données associées à une demande de tirage.
Nom | Type | Description |
---|---|---|
_links |
Reference |
Liens vers d’autres objets connexes. |
artifactId |
string |
Chaîne qui identifie de manière unique cette demande de tirage. Pour générer un ID d’artefact pour une demande de tirage, utilisez ce modèle : |
autoCompleteSetBy |
Identity |
Si elle est définie, la saisie semi-automatique est activée pour cette demande de tirage et il s’agit de l’identité qui l’a activée. |
closedBy |
Identity |
Utilisateur qui a fermé la demande de tirage. |
closedDate |
string |
Date à laquelle la demande de tirage a été fermée (terminée, abandonnée ou fusionnée en externe). |
codeReviewId |
integer |
ID de révision de code de la demande de tirage. Utilisé en interne. |
commits |
Git |
Commits contenus dans la demande de tirage. |
completionOptions |
Git |
Options qui affectent la façon dont la demande de tirage sera fusionnée une fois terminée. |
completionQueueTime |
string |
Date la plus récente à laquelle la demande de tirage est entrée dans la file d’attente à terminer. Utilisé en interne. |
createdBy |
Identity |
Identité de l’utilisateur qui a créé la demande de tirage. |
creationDate |
string |
Date de création de la demande de tirage. |
description |
string |
Description de la demande de tirage. |
forkSource |
Git |
S’il s’agit d’une demande de tirage provenant d’une duplication, celle-ci contiendra des informations sur sa source. |
hasMultipleMergeBases |
boolean |
Avertissement de plusieurs mergebases |
isDraft |
boolean |
Brouillon/demande de tirage WIP. |
labels |
Web |
Étiquettes associées à la demande de tirage. |
lastMergeCommit |
Git |
Validation de la fusion de demande de tirage la plus récente. Si elle est vide, la fusion la plus récente est en cours ou a échoué. |
lastMergeSourceCommit |
Git |
Commit en tête de la branche source au moment de la dernière fusion de la demande de tirage. |
lastMergeTargetCommit |
Git |
Commit en tête de la branche cible au moment de la dernière fusion de la demande de tirage. |
mergeFailureMessage |
string |
Si la valeur est définie, la fusion des demandes de tirage a échoué pour cette raison. |
mergeFailureType |
Pull |
Type d’échec (le cas échéant) de la fusion de demande de tirage. |
mergeId |
string |
ID du travail utilisé pour exécuter la fusion de demande de tirage. Utilisé en interne. |
mergeOptions |
Git |
Options utilisées lors de l’exécution de la fusion de la demande de tirage. Celles-ci sont distinctes des options de saisie semi-automatique, car l’achèvement ne se produit qu’une seule fois et une nouvelle fusion s’exécute chaque fois que la branche source de la demande de tirage change. |
mergeStatus |
Pull |
Status actuelle de la fusion de la demande de tirage. |
pullRequestId |
integer |
ID de la demande de tirage. |
remoteUrl |
string |
Utilisé en interne. |
repository |
Git |
Dépôt contenant la branche cible de la demande de tirage. |
reviewers |
Identity |
Liste des réviseurs sur la demande de tirage ainsi que l’état de leurs votes. |
sourceRefName |
string |
Nom de la branche source de la demande de tirage. |
status |
Pull |
Status de la demande de tirage. |
supportsIterations |
boolean |
Si la valeur est true, cette demande de tirage prend en charge plusieurs itérations. La prise en charge des itérations signifie que les envois push individuels vers la branche source de la demande de tirage peuvent être examinés et que les commentaires laissés dans une itération seront suivis sur les itérations futures. |
targetRefName |
string |
Nom de la branche cible de la demande de tirage. |
title |
string |
Titre de la demande de tirage. |
url |
string |
Utilisé en interne. |
workItemRefs |
Resource |
Toutes les références d’élément de travail associées à cette demande de tirage. |
GitPullRequestCompletionOptions
Préférences relatives à la façon dont la demande de tirage doit être effectuée.
Nom | Type | Description |
---|---|---|
autoCompleteIgnoreConfigIds |
integer[] |
Liste des ID de configuration de stratégie que la saisie semi-automatique ne doit pas attendre. S’applique uniquement aux stratégies facultatives (isBlocking == false). La saisie semi-automatique attend toujours les stratégies requises (isBlocking == true). |
bypassPolicy |
boolean |
Si la valeur est true, les stratégies sont explicitement ignorées lorsque la demande de tirage est terminée. |
bypassReason |
string |
Si les stratégies sont contournées, cette raison est stockée sur la raison pour laquelle la déviation a été utilisée. |
deleteSourceBranch |
boolean |
Si la valeur est true, la branche source de la demande de tirage sera supprimée une fois l’opération terminée. |
mergeCommitMessage |
string |
S’il est défini, il est utilisé comme message de validation de la validation de fusion. |
mergeStrategy |
Git |
Spécifiez la stratégie utilisée pour fusionner la demande de tirage pendant l’achèvement. Si MergeStrategy n’est défini sur aucune valeur, une fusion sans FF est créée si SquashMerge == false. Si MergeStrategy n’est défini sur aucune valeur, les validations de demande de tirage sont écrasées si SquashMerge == true. La propriété SquashMerge est déconseillée. Il est recommandé de définir explicitement MergeStrategy dans tous les cas. Si une valeur explicite est fournie pour MergeStrategy, la propriété SquashMerge est ignorée. |
squashMerge |
boolean |
SquashMerge est déconseillé. Vous devez définir explicitement la valeur de MergeStrategy. Si MergeStrategy est défini sur une valeur quelconque, la valeur SquashMerge est ignorée. Si MergeStrategy n’est pas défini, la stratégie de fusion n’est pas rapide si cet indicateur a la valeur false ou squashing si la valeur est true. |
transitionWorkItems |
boolean |
Si la valeur est true, nous tenterons de faire passer tous les éléments de travail liés à la demande de tirage dans l’état logique suivant (c’est-à-dire Actif -> Résolu) |
triggeredByAutoComplete |
boolean |
Si la valeur est true, la tentative d’achèvement actuelle a été déclenchée via la saisie semi-automatique. Utilisé en interne. |
GitPullRequestMergeOptions
Options utilisées lors de la création d’une fusion de demande de tirage.
Nom | Type | Description |
---|---|---|
conflictAuthorshipCommits |
boolean |
Si la valeur est true, les résolutions de conflit appliquées pendant la fusion sont placées dans des commits distincts pour conserver les informations de création pour le blâme Git, etc. |
detectRenameFalsePositives |
boolean |
|
disableRenames |
boolean |
Si la valeur est true, la détection de renommage n’est pas effectuée pendant la fusion. |
GitPullRequestMergeStrategy
Spécifiez la stratégie utilisée pour fusionner la demande de tirage lors de l’achèvement. Si MergeStrategy n’est défini sur aucune valeur, une fusion sans FF est créée si SquashMerge == false. Si MergeStrategy n’est défini sur aucune valeur, les validations de demande de tirage sont écrasées si SquashMerge == true. La propriété SquashMerge est déconseillée. Il est recommandé de définir explicitement MergeStrategy dans tous les cas. Si une valeur explicite est fournie pour MergeStrategy, la propriété SquashMerge est ignorée.
Nom | Type | Description |
---|---|---|
noFastForward |
string |
Fusion biparentale sans avance rapide. La branche source est inchangée. Il s'agit du comportement par défaut. |
rebase |
string |
Rebasez la branche source au-dessus de la branche cible HEAD commit et avancez rapidement la branche cible. La branche source est mise à jour pendant l’opération de rebasement. |
rebaseMerge |
string |
Rebasez la branche source au-dessus de la branche cible HEAD commit, puis créez une fusion bi-parente sans avance rapide. La branche source est mise à jour pendant l’opération de rebasement. |
squash |
string |
Placez toutes les modifications de la demande de tirage dans un commit monoparentale. |
GitPushRef
Nom | Type | Description |
---|---|---|
_links |
Reference |
Classe pour représenter une collection de liens de référence REST. |
date |
string |
|
pushId |
integer |
|
pushedBy |
Identity |
|
url |
string |
GitRepository
Nom | Type | Description |
---|---|---|
_links |
Reference |
Classe pour représenter une collection de liens de référence REST. |
defaultBranch |
string |
|
id |
string |
|
isDisabled |
boolean |
True si le dépôt est désactivé. Sinon, false. |
isFork |
boolean |
True si le dépôt a été créé en tant que duplication. |
isInMaintenance |
boolean |
True si le dépôt est en maintenance. Sinon, false. |
name |
string |
|
parentRepository |
Git |
|
project |
Team |
Représente une référence superficielle à un TeamProject. |
remoteUrl |
string |
|
size |
integer |
Taille compressée (octets) du dépôt. |
sshUrl |
string |
|
url |
string |
|
validRemoteUrls |
string[] |
|
webUrl |
string |
GitRepositoryRef
Nom | Type | Description |
---|---|---|
collection |
Team |
Collection de projets d’équipe où réside cette duplication |
id |
string |
|
isFork |
boolean |
True si le dépôt a été créé en tant que duplication |
name |
string |
|
project |
Team |
Représente une référence superficielle à un TeamProject. |
remoteUrl |
string |
|
sshUrl |
string |
|
url |
string |
GitStatus
Cette classe contient les métadonnées d’un service/d’une extension qui publie un status.
Nom | Type | Description |
---|---|---|
_links |
Reference |
Liens de référence. |
context |
Git |
Contexte du status. |
createdBy |
Identity |
Identité qui a créé le status. |
creationDate |
string |
Date et heure de création du status. |
description |
string |
Description de l’état. Décrit généralement l’état actuel du status. |
id |
integer |
Identificateur d’état. |
state |
Git |
État du status. |
targetUrl |
string |
URL avec status détails. |
updatedDate |
string |
Date et heure de la dernière mise à jour du status. |
GitStatusContext
Contexte d’état qui identifie de manière unique le status.
Nom | Type | Description |
---|---|---|
genre |
string |
Genre du status. En règle générale, le nom du service/de l’outil qui génère le status peut être vide. |
name |
string |
Identificateur de nom du status, ne peut pas être null ou vide. |
GitStatusState
État du status.
Nom | Type | Description |
---|---|---|
error |
string |
État avec une erreur. |
failed |
string |
Échec de l’état. |
notApplicable |
string |
L’état n’est pas applicable à l’objet cible. |
notSet |
string |
État non défini. État par défaut. |
pending |
string |
État en attente. |
succeeded |
string |
État réussi. |
GitTemplate
Nom | Type | Description |
---|---|---|
name |
string |
Nom du modèle |
type |
string |
Type du modèle |
GitUserDate
Informations utilisateur et date pour les opérations Git.
Nom | Type | Description |
---|---|---|
date |
string |
Date de l’opération Git. |
string |
Email adresse de l’utilisateur effectuant l’opération Git. |
|
imageUrl |
string |
URL de l’avatar de l’utilisateur. |
name |
string |
Nom de l’utilisateur effectuant l’opération Git. |
IdentityRef
Nom | Type | Description |
---|---|---|
_links |
Reference |
Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique. |
descriptor |
string |
Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations. |
directoryAlias |
string |
Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « self » du dictionnaire IdentityRef « _links » |
displayName |
string |
Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source. |
id |
string |
|
imageUrl |
string |
Déprécié : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links » |
inactive |
boolean |
Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links » |
isAadIdentity |
boolean |
Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef |
uniqueName |
string |
Déconseillé : utilisez à la place Domain+PrincipalName |
url |
string |
Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique. |
IdentityRefWithVote
Informations d’identité, y compris un vote sur une demande de tirage.
Nom | Type | Description |
---|---|---|
_links |
Reference |
Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique. |
descriptor |
string |
Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations. |
directoryAlias |
string |
Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « self » du dictionnaire IdentityRef « _links » |
displayName |
string |
Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source. |
hasDeclined |
boolean |
Indique si ce réviseur a refusé d’examiner cette demande de tirage. |
id |
string |
|
imageUrl |
string |
Déprécié : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links » |
inactive |
boolean |
Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links » |
isAadIdentity |
boolean |
Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
isFlagged |
boolean |
Indique si ce réviseur est marqué pour attirer l’attention sur cette demande de tirage. |
isReapprove |
boolean |
Indique si ce vote d’approbation doit toujours être géré même si le vote n’a pas changé. |
isRequired |
boolean |
Indique s’il s’agit d’un réviseur requis pour cette demande de tirage. |
profileUrl |
string |
Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef |
reviewerUrl |
string |
URL permettant de récupérer des informations sur cette identité |
uniqueName |
string |
Déconseillé : utilisez à la place Domain+PrincipalName |
url |
string |
Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique. |
vote |
integer |
Votez sur une demande de tirage : |
votedFor |
Identity |
Groupes ou équipes auxquels ce réviseur a contribué. |
ItemContent
Nom | Type | Description |
---|---|---|
content |
string |
|
contentType |
Item |
ItemContentType
Nom | Type | Description |
---|---|---|
base64Encoded |
string |
|
rawText |
string |
ProjectState
État du projet.
Nom | Type | Description |
---|---|---|
all |
string |
Tous les projets, quel que soit leur état, sauf Supprimé. |
createPending |
string |
Project a été mis en file d’attente pour la création, mais le processus n’a pas encore démarré. |
deleted |
string |
Le projet a été supprimé. |
deleting |
string |
Project est en cours de suppression. |
new |
string |
Project est en cours de création. |
unchanged |
string |
Le projet n’a pas été modifié. |
wellFormed |
string |
Le projet est entièrement créé et prêt à être utilisé. |
ProjectVisibility
Visibilité du projet.
Nom | Type | Description |
---|---|---|
private |
string |
Le projet n’est visible que par les utilisateurs disposant d’un accès explicite. |
public |
string |
Le projet est visible par tous. |
PullRequestAsyncStatus
La status actuelle de la fusion des demandes de tirage.
Nom | Type | Description |
---|---|---|
conflicts |
string |
La fusion des demandes de tirage a échoué en raison de conflits. |
failure |
string |
Échec de la fusion des demandes de tirage. |
notSet |
string |
L’état n’est pas défini. État par défaut. |
queued |
string |
La fusion des demandes de tirage est mise en file d’attente. |
rejectedByPolicy |
string |
Fusion des demandes de tirage rejetée par la stratégie. |
succeeded |
string |
La fusion des demandes de tirage a réussi. |
PullRequestMergeFailureType
Type d’échec (le cas échéant) de la fusion de demande de tirage.
Nom | Type | Description |
---|---|---|
caseSensitive |
string |
La fusion des demandes de tirage a échoué en raison d’une incompatibilité de cas. |
none |
string |
Le type n’est pas défini. Type par défaut. |
objectTooLarge |
string |
La fusion des demandes de tirage a échoué en raison d’un objet trop volumineux. |
unknown |
string |
Type d’échec de fusion de demande de tirage inconnu. |
PullRequestStatus
Status de la demande de tirage.
Nom | Type | Description |
---|---|---|
abandoned |
string |
La demande de tirage est abandonnée. |
active |
string |
La demande de tirage est active. |
all |
string |
Utilisé dans les critères de recherche de demande de tirage pour inclure tous les états. |
completed |
string |
La demande de tirage est terminée. |
notSet |
string |
État non défini. État par défaut. |
ReferenceLinks
Classe pour représenter une collection de liens de référence REST.
Nom | Type | Description |
---|---|---|
links |
object |
Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule. |
ResourceRef
Nom | Type | Description |
---|---|---|
id |
string |
|
url |
string |
TeamProjectCollectionReference
Objet de référence pour un TeamProjectCollection.
Nom | Type | Description |
---|---|---|
avatarUrl |
string |
URL de l’avatar de la collection. |
id |
string |
ID de collection. |
name |
string |
Nom de la collection. |
url |
string |
URL REST de la collection. |
TeamProjectReference
Représente une référence superficielle à un TeamProject.
Nom | Type | Description |
---|---|---|
abbreviation |
string |
Abréviation du projet. |
defaultTeamImageUrl |
string |
Url de l’image d’identité d’équipe par défaut. |
description |
string |
Description du projet (le cas échéant). |
id |
string |
Identificateur de projet. |
lastUpdateTime |
string |
Heure de la dernière mise à jour du projet. |
name |
string |
Nom du projet. |
revision |
integer |
Révision du projet. |
state |
Project |
État du projet. |
url |
string |
Url vers la version complète de l’objet. |
visibility |
Project |
Visibilité du projet. |
VersionControlChangeType
Type de modification apportée à l’élément.
Nom | Type | Description |
---|---|---|
add |
string |
|
all |
string |
|
branch |
string |
|
delete |
string |
|
edit |
string |
|
encoding |
string |
|
lock |
string |
|
merge |
string |
|
none |
string |
|
property |
string |
|
rename |
string |
|
rollback |
string |
|
sourceRename |
string |
|
targetRename |
string |
|
undelete |
string |
WebApiTagDefinition
Représentation d’une définition de balise qui est envoyée sur le réseau.
Nom | Type | Description |
---|---|---|
active |
boolean |
Indique si la définition de balise est active ou non. |
id |
string |
ID de la définition de balise. |
name |
string |
Nom de la définition de balise. |
url |
string |
URL de ressource pour la définition de balise. |