Pull Request Statuses - Get

Référence

Service:: Git

API Version:: 4.1-preview.1

Obtenez la demande de tirage status par ID. L’ID status est unique dans la demande de tirage sur toutes les itérations.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}?api-version=4.1-preview.1

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
pullRequestId	path	True	integer int32	ID de la demande de tirage.
repositoryId	path	True	string	ID de dépôt de la branche cible de la demande de tirage.
statusId	path	True	integer int32	ID du status 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 « 4.1-preview.1 » pour utiliser cette version de l’API.

Réponses

Nom	Type	Description
200 OK	GitPullRequestStatus	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é d’être informé des événements de contrôle de version via des hooks de service.
vso.code_status	Accorde la possibilité de lire et d’écrire des status de validation et de demande de tirage.

Exemples

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}?api-version=4.1-preview.1

Sample Response

Status code:: 200

{
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:27.4949745Z",
  "updatedDate": "2017-09-19T14:50:27.4949745Z",
  "createdBy": {
    "id": "6f168adb-59d4-4fc0-be3b-fb21b939b2a6",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://dev.azure.com/fabrikam/_apis/Identities/6f168adb-59d4-4fc0-be3b-fb21b939b2a6",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=6f168adb-59d4-4fc0-be3b-fb21b939b2a6"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272/pullRequests/5/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

Définitions

Nom	Description
GitPullRequestStatus	Cette classe contient les métadonnées d’une demande de tirage de publication de service/extension status. L’état peut être associé à une demande de tirage ou à une itération.
GitStatusContext	Contexte d’état qui identifie de manière unique le status.
GitStatusState	État du status.
IdentityRef
PropertiesCollection	La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un `TypeCode != TypeCode.Object`) à l’exception de `DBNull` sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.

GitPullRequestStatus

Cette classe contient les métadonnées d’une demande de tirage de publication de service/extension status. L’état peut être associé à une demande de tirage ou à une itération.

Nom	Type	Description
_links	ReferenceLinks	Liens de référence.
context	GitStatusContext	Contexte du status.
createdBy	IdentityRef	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.
iterationId	integer	ID de l’itération à laquelle associer status. La valeur minimale est 1.
properties	PropertiesCollection	Propriétés personnalisées du status.
state	GitStatusState	É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.

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	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
profileUrl	string
uniqueName	string
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

PropertiesCollection

La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.

Nom	Type	Description
count	integer	Nombre de propriétés dans la collection.
item	object
keys	string[]	Ensemble de clés dans la collection.
values	string[]	Ensemble de valeurs dans la collection.

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.

Partager via