Share via


Pull Requests - Get Pull Requests

Recuperare tutte le richieste pull corrispondenti a criteri specificati.

Si noti che il campo di descrizione verrà troncato fino a 400 simboli nel risultato.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?api-version=7.0
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?searchCriteria.creatorId={searchCriteria.creatorId}&searchCriteria.includeLinks={searchCriteria.includeLinks}&searchCriteria.repositoryId={searchCriteria.repositoryId}&searchCriteria.reviewerId={searchCriteria.reviewerId}&searchCriteria.sourceRefName={searchCriteria.sourceRefName}&searchCriteria.sourceRepositoryId={searchCriteria.sourceRepositoryId}&searchCriteria.status={searchCriteria.status}&searchCriteria.targetRefName={searchCriteria.targetRefName}&maxCommentLength={maxCommentLength}&$skip={$skip}&$top={$top}&api-version=7.0

Parametri dell'URI

Nome In Necessario Tipo Descrizione
organization
path True

string

Nome dell'organizzazione di Azure DevOps.

repositoryId
path True

string

ID repository del ramo di destinazione della richiesta pull.

project
path

string

ID progetto o nome progetto

api-version
query True

string

Versione dell'API da usare. Questa opzione deve essere impostata su '7.0' per usare questa versione dell'API.

$skip
query

integer

int32

Numero di richieste pull da ignorare. Ad esempio, per recuperare i risultati 101-150, impostare top su 50 e passare a 100.

$top
query

integer

int32

Numero di richieste pull da recuperare.

maxCommentLength
query

integer

int32

Non usato.

searchCriteria.creatorId
query

string

uuid

Se impostato, cercare le richieste pull create da questa identità.

searchCriteria.includeLinks
query

boolean

Indica se includere il campo _links nei riferimenti superficiali

searchCriteria.repositoryId
query

string

uuid

Se impostato, cercare le richieste pull il cui ramo di destinazione si trova in questo repository.

searchCriteria.reviewerId
query

string

uuid

Se impostato, cercare le richieste pull con questa identità come revisore.

searchCriteria.sourceRefName
query

string

Se impostato, cercare richieste pull da questo ramo.

searchCriteria.sourceRepositoryId
query

string

uuid

Se impostato, cercare le richieste pull il cui ramo di origine si trova in questo repository.

searchCriteria.status
query

PullRequestStatus

Se impostato, cercare le richieste pull in questo stato. Impostazione predefinita su Attivo se non viene impostato.

searchCriteria.targetRefName
query

string

Se impostato, cercare richieste pull in questo ramo.

Risposte

Nome Tipo Descrizione
200 OK

GitPullRequest[]

operazione riuscita

Sicurezza

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

Nome Descrizione
vso.code Concede la possibilità di leggere codice sorgente e metadati relativi a commit, set di modifiche, rami e altri artefatti di controllo della versione. Concede inoltre la possibilità di cercare codice e ricevere notifiche sugli eventi di controllo della versione tramite gli hook del servizio.

Esempio

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=7.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=7.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=7.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
}

Definizioni

Nome Descrizione
ChangeCountDictionary
GitChange
GitCommitRef

Fornisce proprietà che descrivono un commit Git e metadati associati.

GitForkRef

Informazioni su un fork ref.

GitPullRequest

Rappresenta tutti i dati associati a una richiesta pull.

GitPullRequestCompletionOptions

Preferenze sulla modalità di completamento della richiesta pull.

GitPullRequestMergeOptions

Opzioni usate quando viene creata un'unione di richieste pull.

GitPullRequestMergeStrategy

Specificare la strategia utilizzata per unire la richiesta pull durante il completamento. Se MergeStrategy non è impostato su alcun valore, verrà creata un'unione no-FF se SquashMerge == false. Se MergeStrategy non è impostato su alcun valore, i commit della richiesta pull verranno schiacciati se SquashMerge == true. La proprietà SquashMerge è deprecata. È consigliabile impostare in modo esplicito MergeStrategy in tutti i casi. Se viene specificato un valore esplicito per MergeStrategy, la proprietà SquashMerge verrà ignorata.

GitPushRef
GitRepository
GitRepositoryRef
GitStatus

Questa classe contiene i metadati di un servizio/estensione che registrano uno stato.

GitStatusContext

Contesto di stato che identifica in modo univoco lo stato.

GitStatusState

Stato dello stato.

GitTemplate
GitUserDate

Informazioni utente e data per le operazioni Git.

IdentityRef
IdentityRefWithVote

Informazioni sull'identità, tra cui un voto su una richiesta pull.

ItemContent
ItemContentType
ProjectState

Stato del progetto.

ProjectVisibility

Visibilità del progetto.

PullRequestAsyncStatus

Stato corrente dell'unione della richiesta pull.

PullRequestMergeFailureType

Tipo di errore (se presente) dell'unione della richiesta pull.

PullRequestStatus

Stato della richiesta pull.

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

ResourceRef
TeamProjectCollectionReference

Oggetto di riferimento per un Oggetto TeamProjectCollection.

TeamProjectReference

Rappresenta un riferimento superficiale a un TeamProject.

VersionControlChangeType

Tipo di modifica apportata all'elemento.

WebApiTagDefinition

Rappresentazione di una definizione di tag inviata attraverso il filo.

ChangeCountDictionary

GitChange

Nome Tipo Descrizione
changeId

integer

ID della modifica all'interno del gruppo di modifiche.

changeType

VersionControlChangeType

Tipo di modifica apportata all'elemento.

item

string

Versione corrente.

newContent

ItemContent

Contenuto dell'elemento dopo la modifica.

newContentTemplate

GitTemplate

Nuovo modello di contenuto da usare durante il push di nuove modifiche.

originalPath

string

Percorso originale dell'elemento se diverso dal percorso corrente.

sourceServerItem

string

Percorso dell'elemento nel server.

url

string

URL per recuperare l'elemento.

GitCommitRef

Fornisce proprietà che descrivono un commit Git e metadati associati.

Nome Tipo Descrizione
_links

ReferenceLinks

Raccolta di collegamenti di riferimento REST correlati.

author

GitUserDate

Autore del commit.

changeCounts

ChangeCountDictionary

Conteggi dei tipi di modifiche (modifiche, eliminazioni e così via) incluse nel commit.

changes

GitChange[]

Enumerazione delle modifiche incluse nel commit.

comment

string

Commento o messaggio del commit.

commentTruncated

boolean

Indica se il commento viene troncato dal messaggio di commento del commit Git completo.

commitId

string

ID (SHA-1) del commit.

committer

GitUserDate

Commiter del commit.

parents

string[]

Enumerazione degli ID commit padre per questo commit.

push

GitPushRef

Push associato a questo commit.

remoteUrl

string

Percorso URL remoto al commit.

statuses

GitStatus[]

Elenco dei metadati di stato dai servizi e dalle estensioni che possono associare informazioni aggiuntive al commit.

url

string

URL REST per questa risorsa.

workItems

ResourceRef[]

Elenco di elementi di lavoro associati al commit.

GitForkRef

Informazioni su un fork ref.

Nome Tipo Descrizione
_links

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

creator

IdentityRef

isLocked

boolean

isLockedBy

IdentityRef

name

string

objectId

string

peeledObjectId

string

repository

GitRepository

ID repository del fork.

statuses

GitStatus[]

Questa classe contiene i metadati di un servizio/estensione che registrano uno stato.

url

string

GitPullRequest

Rappresenta tutti i dati associati a una richiesta pull.

Nome Tipo Descrizione
_links

ReferenceLinks

Collegamenti ad altri oggetti correlati.

artifactId

string

Stringa che identifica in modo univoco questa richiesta pull. Per generare un ID artefatto per una richiesta pull, usare questo modello: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

autoCompleteSetBy

IdentityRef

Se impostato, il completamento automatico è abilitato per questa richiesta pull e questa è l'identità abilitata.

closedBy

IdentityRef

Utente che ha chiuso la richiesta pull.

closedDate

string

Data di chiusura della richiesta pull (completata, abbandonata o unita esternamente).

codeReviewId

integer

ID di revisione del codice della richiesta pull. Per uso interno.

commits

GitCommitRef[]

I commit contenuti nella richiesta pull.

completionOptions

GitPullRequestCompletionOptions

Opzioni che influiscono sul modo in cui la richiesta pull verrà unita al completamento.

completionQueueTime

string

Data più recente in cui la richiesta pull ha immesso la coda da completare. Per uso interno.

createdBy

IdentityRef

Identità dell'utente che ha creato la richiesta pull.

creationDate

string

Data di creazione della richiesta pull.

description

string

Descrizione della richiesta pull.

forkSource

GitForkRef

Se si tratta di una richiesta pr da un fork, questo conterrà informazioni sulla relativa origine.

hasMultipleMergeBases

boolean

Avviso di più mergebase

isDraft

boolean

Richiesta pull bozza/WIP.

labels

WebApiTagDefinition[]

Etichette associate alla richiesta pull.

lastMergeCommit

GitCommitRef

Commit del merge della richiesta pull più recente. Se vuoto, l'unione più recente è in corso o ha avuto esito negativo.

lastMergeSourceCommit

GitCommitRef

Commit all'inizio del ramo di origine al momento dell'ultima unione della richiesta pull.

lastMergeTargetCommit

GitCommitRef

Commit all'inizio del ramo di destinazione al momento dell'ultima unione della richiesta pull.

mergeFailureMessage

string

Se impostato, l'unione della richiesta pull non è riuscita per questo motivo.

mergeFailureType

PullRequestMergeFailureType

Tipo di errore (se presente) dell'unione della richiesta pull.

mergeId

string

ID del processo usato per eseguire l'unione della richiesta pull. Per uso interno.

mergeOptions

GitPullRequestMergeOptions

Opzioni usate quando viene eseguita l'unione della richiesta pull. Queste sono separate dalle opzioni di completamento poiché il completamento avviene una sola volta e una nuova unione verrà eseguita ogni volta che il ramo di origine della richiesta pull cambia.

mergeStatus

PullRequestAsyncStatus

Stato corrente dell'unione della richiesta pull.

pullRequestId

integer

ID della richiesta pull.

remoteUrl

string

Per uso interno.

repository

GitRepository

Repository contenente il ramo di destinazione della richiesta pull.

reviewers

IdentityRefWithVote[]

Elenco di revisori sulla richiesta pull insieme allo stato dei loro voti.

sourceRefName

string

Nome del ramo di origine della richiesta pull.

status

PullRequestStatus

Stato della richiesta pull.

supportsIterations

boolean

Se true, questa richiesta pull supporta più iterazioni. Il supporto dell'iterazione significa che i singoli push nel ramo di origine della richiesta pull possono essere esaminati e i commenti lasciati in un'iterazione verranno rilevati tra iterazioni future.

targetRefName

string

Nome del ramo di destinazione della richiesta pull.

title

string

Titolo della richiesta pull.

url

string

Per uso interno.

workItemRefs

ResourceRef[]

Tutti i riferimenti all'elemento di lavoro associati a questa richiesta pull.

GitPullRequestCompletionOptions

Preferenze sulla modalità di completamento della richiesta pull.

Nome Tipo Descrizione
autoCompleteIgnoreConfigIds

integer[]

Elenco di tutti gli ID di configurazione dei criteri che non devono attendere il completamento automatico. Si applica solo ai criteri facoltativi (isBlocking == false). Il completamento automatico attende sempre i criteri obbligatori (isBlocking == true).

bypassPolicy

boolean

Se true, i criteri verranno ignorati in modo esplicito mentre la richiesta pull viene completata.

bypassReason

string

Se i criteri vengono ignorati, questo motivo viene archiviato come motivo per cui è stato usato il bypass.

deleteSourceBranch

boolean

Se true, il ramo di origine della richiesta pull verrà eliminato dopo il completamento.

mergeCommitMessage

string

Se impostato, verrà usato come messaggio di commit del commit del commit.

mergeStrategy

GitPullRequestMergeStrategy

Specificare la strategia utilizzata per unire la richiesta pull durante il completamento. Se MergeStrategy non è impostato su alcun valore, verrà creata un'unione no-FF se SquashMerge == false. Se MergeStrategy non è impostato su alcun valore, i commit della richiesta pull verranno schiacciati se SquashMerge == true. La proprietà SquashMerge è deprecata. È consigliabile impostare in modo esplicito MergeStrategy in tutti i casi. Se viene specificato un valore esplicito per MergeStrategy, la proprietà SquashMerge verrà ignorata.

squashMerge

boolean

SquashMerge è deprecato. È necessario impostare in modo esplicito il valore di MergeStrategy. Se MergeStrategy è impostato su qualsiasi valore, il valore SquashMerge verrà ignorato. Se MergeStrategy non è impostato, la strategia di unione sarà senza inoltro rapido se questo flag è false o squash se true.

transitionWorkItems

boolean

Se true, si tenterà di eseguire la transizione di eventuali elementi di lavoro collegati alla richiesta pull nello stato logico successivo (ad esempio Active -> Resolved)

triggeredByAutoComplete

boolean

Se true, il tentativo di completamento corrente è stato attivato tramite il completamento automatico. Per uso interno.

GitPullRequestMergeOptions

Opzioni usate quando viene creata un'unione di richieste pull.

Nome Tipo Descrizione
conflictAuthorshipCommits

boolean

Se true, le risoluzioni dei conflitti applicate durante l'unione verranno inserite in commit separati per mantenere le informazioni sulla creazione per git con colpa e così via.

detectRenameFalsePositives

boolean

disableRenames

boolean

Se true, il rilevamento della ridenominazione non verrà eseguito durante l'unione.

GitPullRequestMergeStrategy

Specificare la strategia utilizzata per unire la richiesta pull durante il completamento. Se MergeStrategy non è impostato su alcun valore, verrà creata un'unione no-FF se SquashMerge == false. Se MergeStrategy non è impostato su alcun valore, i commit della richiesta pull verranno schiacciati se SquashMerge == true. La proprietà SquashMerge è deprecata. È consigliabile impostare in modo esplicito MergeStrategy in tutti i casi. Se viene specificato un valore esplicito per MergeStrategy, la proprietà SquashMerge verrà ignorata.

Nome Tipo Descrizione
noFastForward

string

Unione a due elementi padre, no-fast-forward. Il ramo di origine è invariato. Questo è il comportamento predefinito.

rebase

string

Ribasere il ramo di origine sopra il commit HEAD del ramo di destinazione e inoltrare rapidamente il ramo di destinazione. Il ramo di origine viene aggiornato durante l'operazione di ribase.

rebaseMerge

string

Ribasere il ramo di origine sopra il commit HEAD del ramo di destinazione e creare un merge a due elementi padre, senza inoltro rapido. Il ramo di origine viene aggiornato durante l'operazione di ribase.

squash

string

Inserire tutte le modifiche dalla richiesta pull in un commit single-parent.

GitPushRef

Nome Tipo Descrizione
_links

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

date

string

pushId

integer

pushedBy

IdentityRef

url

string

GitRepository

Nome Tipo Descrizione
_links

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

defaultBranch

string

id

string

isDisabled

boolean

True se il repository è disabilitato. False in caso contrario.

isFork

boolean

True se il repository è stato creato come fork.

name

string

parentRepository

GitRepositoryRef

project

TeamProjectReference

Rappresenta un riferimento superficiale a un TeamProject.

remoteUrl

string

size

integer

Dimensioni compresse (byte) del repository.

sshUrl

string

url

string

validRemoteUrls

string[]

webUrl

string

GitRepositoryRef

Nome Tipo Descrizione
collection

TeamProjectCollectionReference

Raccolta di progetti team in cui risiede questo fork

id

string

isFork

boolean

True se il repository è stato creato come fork

name

string

project

TeamProjectReference

Rappresenta un riferimento superficiale a un TeamProject.

remoteUrl

string

sshUrl

string

url

string

GitStatus

Questa classe contiene i metadati di un servizio/estensione che registrano uno stato.

Nome Tipo Descrizione
_links

ReferenceLinks

Collegamenti di riferimento.

context

GitStatusContext

Contesto dello stato.

createdBy

IdentityRef

Identità che ha creato lo stato.

creationDate

string

Data e ora di creazione dello stato.

description

string

Descrizione dello stato. In genere viene descritto lo stato corrente dello stato.

id

integer

Identificatore di stato.

state

GitStatusState

Stato dello stato.

targetUrl

string

URL con dettagli sullo stato.

updatedDate

string

Ultima data e ora di aggiornamento dello stato.

GitStatusContext

Contesto di stato che identifica in modo univoco lo stato.

Nome Tipo Descrizione
genre

string

Genere dello stato. In genere, il nome del servizio o dello strumento che genera lo stato può essere vuoto.

name

string

L'identificatore del nome dello stato non può essere null o vuoto.

GitStatusState

Stato dello stato.

Nome Tipo Descrizione
error

string

Stato con un errore.

failed

string

Stato non riuscito.

notApplicable

string

Lo stato non è applicabile all'oggetto di destinazione.

notSet

string

Stato non impostato. Stato predefinito.

pending

string

Stato in sospeso.

succeeded

string

Stato completato.

GitTemplate

Nome Tipo Descrizione
name

string

Nome del modello

type

string

Tipo del modello

GitUserDate

Informazioni utente e data per le operazioni Git.

Nome Tipo Descrizione
date

string

Data dell'operazione Git.

email

string

Email indirizzo dell'utente che esegue l'operazione Git.

imageUrl

string

Url dell'avatar dell'utente.

name

string

Nome dell'utente che esegue l'operazione Git.

IdentityRef

Nome Tipo Descrizione
_links

ReferenceLinks

Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo argomento grafico.

descriptor

string

Il descrittore è il modo principale per fare riferimento all'oggetto del grafico durante l'esecuzione del sistema. Questo campo identificherà in modo univoco lo stesso soggetto grafo in account e organizzazioni.

directoryAlias

string

Deprecato: può essere recuperato eseguendo query sull'utente Graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"

displayName

string

Si tratta del nome visualizzato non univoco dell'oggetto grafico. Per modificare questo campo, è necessario modificarlo nel provider di origine.

id

string

imageUrl

string

Deprecato - Disponibile nella voce "avatar" del dizionario IdentityRef "_links"

inactive

boolean

Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza Graph a cui fa riferimento nella voce "membershipState" del dizionario GraphUser "_links"

isAadIdentity

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descrittore.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

Deprecato : non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef

uniqueName

string

Deprecato: usare invece Domain+PrincipalName

url

string

Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

IdentityRefWithVote

Informazioni sull'identità, tra cui un voto su una richiesta pull.

Nome Tipo Descrizione
_links

ReferenceLinks

Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo argomento grafico.

descriptor

string

Il descrittore è il modo principale per fare riferimento all'oggetto del grafico durante l'esecuzione del sistema. Questo campo identificherà in modo univoco lo stesso soggetto grafo in account e organizzazioni.

directoryAlias

string

Deprecato: può essere recuperato eseguendo query sull'utente Graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"

displayName

string

Si tratta del nome visualizzato non univoco dell'oggetto grafico. Per modificare questo campo, è necessario modificarlo nel provider di origine.

hasDeclined

boolean

Indica se questo revisore ha rifiutato di esaminare questa richiesta pull.

id

string

imageUrl

string

Deprecato - Disponibile nella voce "avatar" del dizionario IdentityRef "_links"

inactive

boolean

Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza Graph a cui fa riferimento nella voce "membershipState" del dizionario GraphUser "_links"

isAadIdentity

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descrittore.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

isFlagged

boolean

Indica se questo revisore viene contrassegnato per l'attenzione su questa richiesta pull.

isRequired

boolean

Indica se si tratta di un revisore obbligatorio per questa richiesta pull.
I rami possono avere criteri che richiedono revisori specifici per le richieste pull.

profileUrl

string

Deprecato : non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef

reviewerUrl

string

URL per recuperare informazioni su questa identità

uniqueName

string

Deprecato: usare invece Domain+PrincipalName

url

string

Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

vote

integer

Votare su una richiesta pull:
10 - approvato 5 - approvato con suggerimenti 0 - nessun voto -5 - in attesa dell'autore -10 - rifiutato

votedFor

IdentityRefWithVote[]

Gruppi o team a cui ha contribuito questo revisore.
I gruppi e i team possono essere revisori sulle richieste pull, ma non possono votare direttamente. Quando un membro del gruppo o del gruppo vota, tale voto viene eseguito nel gruppo o nel voto del team. VoteFor è un elenco di tali voti.

ItemContent

Nome Tipo Descrizione
content

string

contentType

ItemContentType

ItemContentType

Nome Tipo Descrizione
base64Encoded

string

rawText

string

ProjectState

Stato del progetto.

Nome Tipo Descrizione
all

string

Tutti i progetti indipendentemente dallo stato tranne Deleted.

createPending

string

Il progetto è stato accodato per la creazione, ma il processo non è ancora stato avviato.

deleted

string

Il progetto è stato eliminato.

deleting

string

Il progetto si trova nel processo di eliminazione.

new

string

Il progetto è in fase di creazione.

unchanged

string

Il progetto non è stato modificato.

wellFormed

string

Il progetto è completamente creato e pronto per l'uso.

ProjectVisibility

Visibilità del progetto.

Nome Tipo Descrizione
private

string

Il progetto è visibile solo agli utenti con accesso esplicito.

public

string

Il progetto è visibile a tutti.

PullRequestAsyncStatus

Stato corrente dell'unione della richiesta pull.

Nome Tipo Descrizione
conflicts

string

Unione della richiesta pull non riuscita a causa di conflitti.

failure

string

Unione della richiesta pull non riuscita.

notSet

string

Lo stato non è impostato. Stato predefinito.

queued

string

L'unione della richiesta pull viene accodata.

rejectedByPolicy

string

Unione della richiesta pull rifiutata dai criteri.

succeeded

string

Unione della richiesta pull completata.

PullRequestMergeFailureType

Tipo di errore (se presente) dell'unione della richiesta pull.

Nome Tipo Descrizione
caseSensitive

string

Unione della richiesta pull non riuscita a causa della mancata corrispondenza tra maiuscole e minuscole.

none

string

Il tipo non è impostato. Tipo predefinito.

objectTooLarge

string

Unione richiesta pull non riuscita a causa di un oggetto troppo grande.

unknown

string

Tipo di errore di unione della richiesta pull sconosciuto.

PullRequestStatus

Stato della richiesta pull.

Nome Tipo Descrizione
abandoned

string

La richiesta pull viene abbandonata.

active

string

La richiesta pull è attiva.

all

string

Usato nei criteri di ricerca della richiesta pull per includere tutti gli stati.

completed

string

La richiesta pull viene completata.

notSet

string

Stato non impostato. Stato predefinito.

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

ResourceRef

Nome Tipo Descrizione
id

string

url

string

TeamProjectCollectionReference

Oggetto di riferimento per un Oggetto TeamProjectCollection.

Nome Tipo Descrizione
id

string

ID raccolta.

name

string

Nome raccolta.

url

string

URL REST raccolta.

TeamProjectReference

Rappresenta un riferimento superficiale a un TeamProject.

Nome Tipo Descrizione
abbreviation

string

Abbreviazione del progetto.

defaultTeamImageUrl

string

Url dell'immagine di identità del team predefinita.

description

string

Descrizione del progetto (se presente).

id

string

Identificatore del progetto.

lastUpdateTime

string

Ora dell'ultimo aggiornamento del progetto.

name

string

Nome progetto.

revision

integer

Revisione del progetto.

state

ProjectState

Stato del progetto.

url

string

Url alla versione completa dell'oggetto.

visibility

ProjectVisibility

Visibilità del progetto.

VersionControlChangeType

Tipo di modifica apportata all'elemento.

Nome Tipo Descrizione
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

Rappresentazione di una definizione di tag inviata attraverso il filo.

Nome Tipo Descrizione
active

boolean

Indica se la definizione del tag è attiva.

id

string

ID della definizione del tag.

name

string

Nome della definizione del tag.

url

string

URL della risorsa per la definizione di tag.