Pull Requests - Get Pull Requests
Récupérez toutes les demandes de tirage correspondant à un critère spécifié.
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?api-version=5.0
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?searchCriteria.includeLinks={searchCriteria.includeLinks}&searchCriteria.sourceRefName={searchCriteria.sourceRefName}&searchCriteria.sourceRepositoryId={searchCriteria.sourceRepositoryId}&searchCriteria.targetRefName={searchCriteria.targetRefName}&searchCriteria.status={searchCriteria.status}&searchCriteria.reviewerId={searchCriteria.reviewerId}&searchCriteria.creatorId={searchCriteria.creatorId}&searchCriteria.repositoryId={searchCriteria.repositoryId}&maxCommentLength={maxCommentLength}&$skip={$skip}&$top={$top}&api-version=5.0
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 « 5.0 » pour utiliser cette version de l’API. |
$skip
|
query |
integer int32 |
Nombre de demandes de tirage à ignorer. Par exemple, pour récupérer les résultats 101-150, définissez top sur 50 et passez à 100. |
|
$top
|
query |
integer int32 |
Nombre de demandes de tirage à récupérer. |
|
max
|
query |
integer int32 |
Non utilisé. |
|
search
|
query |
string uuid |
Si cette option est définie, recherchez les demandes de tirage créées par cette identité. |
|
search
|
query |
boolean |
Indique s’il faut inclure le champ _links sur les références superficielles |
|
search
|
query |
string uuid |
Si cette option est définie, recherchez les demandes de tirage dont la branche cible se trouve dans ce dépôt. |
|
search
|
query |
string uuid |
Si cette option est définie, recherchez les demandes de tirage qui ont cette identité en tant que réviseur. |
|
search
|
query |
string |
Si cette option est définie, recherchez les demandes de tirage à partir de cette branche. |
|
search
|
query |
string uuid |
Si la valeur est définie, recherchez les demandes de tirage dont la branche source se trouve dans ce référentiel. |
|
search
|
query |
Si cette option est définie, recherchez les demandes de tirage qui se trouvent dans cet état. La valeur par défaut est Active si elle n’est pas définie. |
||
search
|
query |
string |
Si cette option est définie, recherchez les demandes de tirage dans cette branche. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
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 | Accorde la possibilité de lire le code source et les métadonnées sur les commits, les ensembles de modifications, les branches et d’autres artefacts de contrôle de version. Accorde également la possibilité de rechercher du code et d’être informé des événements de contrôle de version via des hooks de service. |
Exemples
Just completed pull requests |
Pull requests by repository |
Targeting a specific branch |
Just completed pull requests
Sample Request
GET https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests?searchCriteria.status=completed&api-version=5.0
Sample Response
{
"value": [
{
"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",
"state": "unchanged"
}
},
"pullRequestId": 20,
"codeReviewId": 20,
"status": "completed",
"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:28:08.8900118Z",
"closedDate": "2016-11-01T16:30:02.0413914Z",
"title": "Updated pull request title",
"description": "Updated pull request description",
"sourceRefName": "refs/heads/npaulk/my_work",
"targetRefName": "refs/heads/new_feature",
"mergeStatus": "succeeded",
"mergeId": "1b5f1536-565e-46f4-ace2-e8cbf50c676b",
"lastMergeSourceCommit": {
"commitId": "ae875f124fe5c625664fae12af26cc294ed1575f",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/ae875f124fe5c625664fae12af26cc294ed1575f"
},
"lastMergeTargetCommit": {
"commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"lastMergeCommit": {
"commitId": "1e924c570d532d92c12e955b9f8948935f54944e",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/1e924c570d532d92c12e955b9f8948935f54944e"
},
"reviewers": [
{
"reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/20/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db",
"vote": 10,
"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/20",
"supportsIterations": true,
"completionQueueTime": "2016-11-01T16:30:00.6380112Z"
}
],
"count": 1
}
Pull requests by repository
Sample Request
GET https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests?api-version=5.0
Sample Response
{
"value": [
{
"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",
"state": "unchanged"
}
},
"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": "succeeded",
"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"
},
"lastMergeCommit": {
"commitId": "39f52d24533cc712fc845ed9fd1b6c06b3942588",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/39f52d24533cc712fc845ed9fd1b6c06b3942588"
},
"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",
"supportsIterations": true
},
{
"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",
"state": "unchanged"
}
},
"pullRequestId": 21,
"codeReviewId": 21,
"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:23.8410158Z",
"title": "Added known issues document",
"description": "Added known issues document",
"sourceRefName": "refs/heads/npaulk/known_issues",
"targetRefName": "refs/heads/new_feature",
"mergeStatus": "succeeded",
"mergeId": "58a34c62-01b5-4029-8337-c99782ee9003",
"lastMergeSourceCommit": {
"commitId": "05ce817c4692afc93c1eb952643bdf7ffbab18ee",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/05ce817c4692afc93c1eb952643bdf7ffbab18ee"
},
"lastMergeTargetCommit": {
"commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"lastMergeCommit": {
"commitId": "bf27525b51b5347483ed9d7dc52ce5a3cf2b045a",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/bf27525b51b5347483ed9d7dc52ce5a3cf2b045a"
},
"reviewers": [
{
"reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/21/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/21",
"supportsIterations": true
},
{
"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",
"state": "unchanged"
}
},
"pullRequestId": 1,
"codeReviewId": 1,
"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-10-31T20:20:32.3087249Z",
"title": "some_branch edit",
"description": " - Updated README.md",
"sourceRefName": "refs/heads/some_branch",
"targetRefName": "refs/heads/master",
"mergeStatus": "succeeded",
"mergeId": "b294fd81-d539-461d-b271-71a6e61f3c24",
"lastMergeSourceCommit": {
"commitId": "34a9e500f29d119802a828d7a759f6fa2e546750",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/34a9e500f29d119802a828d7a759f6fa2e546750"
},
"lastMergeTargetCommit": {
"commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"lastMergeCommit": {
"commitId": "41e98d9939cf4ec0ce166079c22e2b40de862cf5",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/41e98d9939cf4ec0ce166079c22e2b40de862cf5"
},
"reviewers": [
{
"reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/1/reviewers/98d08d98-a075-46e7-a81e-21bc6f12cae7",
"vote": 0,
"id": "98d08d98-a075-46e7-a81e-21bc6f12cae7",
"displayName": "[2016_10_31]\\2016_10_31 Team",
"uniqueName": "vstfs:///Classification/TeamProject/a7573007-bbb3-4341-b726-0c4148a07853\\2016_10_31 Team",
"url": "https://dev.azure.com/fabrikam/_apis/Identities/98d08d98-a075-46e7-a81e-21bc6f12cae7",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=98d08d98-a075-46e7-a81e-21bc6f12cae7",
"isContainer": true
}
],
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/1",
"supportsIterations": true
}
],
"count": 3
}
Targeting a specific branch
Sample Request
GET https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests?searchCriteria.targetRefName=refs/heads/master&api-version=5.0
Sample Response
{
"value": [
{
"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",
"state": "unchanged"
}
},
"pullRequestId": 1,
"codeReviewId": 1,
"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-10-31T20:20:32.3087249Z",
"title": "some_branch edit",
"description": " - Updated README.md",
"sourceRefName": "refs/heads/some_branch",
"targetRefName": "refs/heads/master",
"mergeStatus": "succeeded",
"mergeId": "b294fd81-d539-461d-b271-71a6e61f3c24",
"lastMergeSourceCommit": {
"commitId": "34a9e500f29d119802a828d7a759f6fa2e546750",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/34a9e500f29d119802a828d7a759f6fa2e546750"
},
"lastMergeTargetCommit": {
"commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"lastMergeCommit": {
"commitId": "41e98d9939cf4ec0ce166079c22e2b40de862cf5",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/41e98d9939cf4ec0ce166079c22e2b40de862cf5"
},
"reviewers": [
{
"reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/1/reviewers/98d08d98-a075-46e7-a81e-21bc6f12cae7",
"vote": 0,
"id": "98d08d98-a075-46e7-a81e-21bc6f12cae7",
"displayName": "[2016_10_31]\\2016_10_31 Team",
"uniqueName": "vstfs:///Classification/TeamProject/a7573007-bbb3-4341-b726-0c4148a07853\\2016_10_31 Team",
"url": "https://dev.azure.com/fabrikam/_apis/Identities/98d08d98-a075-46e7-a81e-21bc6f12cae7",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=98d08d98-a075-46e7-a81e-21bc6f12cae7",
"isContainer": true
}
],
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/1",
"supportsIterations": true
}
],
"count": 1
}
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 |
|
Git |
|
Git |
|
Git |
Cette classe contient les métadonnées d’un service/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 la 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 |
Type de modification apportée à l’élément. |
|
item |
string |
Version actuelle. |
newContent |
Contenu de l’élément après la modification. |
|
newContentTemplate |
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 actuel. |
sourceServerItem |
string |
Chemin d’accès 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 |
Collection de liens de référence REST associés. |
|
author |
Auteur de la validation. |
|
changeCounts |
Nombre de types de modifications (modifications, suppressions, etc.) inclus dans la validation. |
|
changes |
É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. |
committer |
Commiter du commit. |
|
parents |
string[] |
Énumération des ID de validation parent pour cette validation. |
push |
Envoi (push) associé à ce commit. |
|
remoteUrl |
string |
Chemin d’URL distante du commit. |
statuses |
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 |
Liste des éléments de travail associés à cette validation. |
GitForkRef
Informations sur une référence fork.
Nom | Type | Description |
---|---|---|
_links |
Classe pour représenter une collection de liens de référence REST. |
|
creator | ||
isLocked |
boolean |
|
isLockedBy | ||
name |
string |
|
objectId |
string |
|
peeledObjectId |
string |
|
repository |
ID de dépôt de la duplication. |
|
statuses |
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 |
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 |
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 |
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 |
Commits contenus dans la demande de tirage. |
|
completionOptions |
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 |
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 |
S’il s’agit d’une demande de tirage provenant d’une duplication, elle contient des informations sur sa source. |
|
isDraft |
boolean |
Brouillon/demande de tirage WIP. |
labels |
Étiquettes associées à la demande de tirage. |
|
lastMergeCommit |
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 |
Commit en tête de la branche source au moment de la dernière fusion de la demande de tirage. |
|
lastMergeTargetCommit |
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 |
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 |
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 |
La status actuelle de la fusion des demandes de tirage. |
|
pullRequestId |
integer |
ID de la demande de tirage. |
remoteUrl |
string |
Utilisé en interne. |
repository |
Référentiel contenant la branche cible de la demande de tirage. |
|
reviewers |
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 |
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 |
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 |
---|---|---|
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. |
squashMerge |
boolean |
Si la valeur est true, les validations dans la demande de tirage sont squashing fusionnées dans la branche cible spécifiée à l’achèvement. |
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 |
---|---|---|
detectRenameFalsePositives |
boolean |
|
disableRenames |
boolean |
Si la valeur est true, la détection de renommage n’est pas effectuée pendant la fusion. |
GitPushRef
Nom | Type | Description |
---|---|---|
_links |
Classe pour représenter une collection de liens de référence REST. |
|
date |
string |
|
pushId |
integer |
|
pushedBy | ||
url |
string |
GitRepository
Nom | Type | Description |
---|---|---|
_links |
Classe pour représenter une collection de liens de référence REST. |
|
defaultBranch |
string |
|
id |
string |
|
isFork |
boolean |
True si le dépôt a été créé en tant que duplication |
name |
string |
|
parentRepository | ||
project |
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[] |
GitRepositoryRef
Nom | Type | Description |
---|---|---|
collection |
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 |
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/extension qui publie un status.
Nom | Type | Description |
---|---|---|
_links |
Liens de référence. |
|
context |
Contexte du status. |
|
createdBy |
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 |
É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 |
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 |
|
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 |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
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 |
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 |
|
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 |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
isRequired |
boolean |
Indique s’il s’agit d’un réviseur requis pour cette demande de tirage. |
profileUrl |
string |
|
reviewerUrl |
string |
URL permettant de récupérer des informations sur cette identité |
uniqueName |
string |
|
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 |
Groupes ou équipes auxquels ce réviseur a contribué. |
ItemContent
Nom | Type | Description |
---|---|---|
content |
string |
|
contentType |
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. |
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 la 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 |
---|---|---|
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 de 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. |
name |
string |
Nom du projet. |
revision |
integer |
Révision du projet. |
state |
État du projet. |
|
url |
string |
Url de la version complète de l’objet. |
visibility |
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. |