Partager via

Pull Request Statuses - Create

  • Référence
Service:
Git
Version d'API:
7.1

Créez un état de demande de tirage( pull request).

Le seul champ requis pour l’état est Context.Name qui identifie de manière unique l’état. Notez que vous pouvez spécifier itérationId dans le corps de la demande pour publier l’état sur l’itération.

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=7.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 référentiel 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 » pour utiliser cette version de l’API.

Corps de la demande

Nom Type Description
_links

ReferenceLinks

Liens de référence.
context

GitStatusContext

Contexte de l’état.
createdBy

IdentityRef

Identité qui a créé l’état.
creationDate

string (date-time)

Date et heure de création de l’état.
description

string

Description de l’état. Décrit généralement l’état actuel de l’état.
id

integer (int32)

Identificateur d’état.
iterationId

integer (int32)

ID de l’itération à laquelle associer l’état. La valeur minimale est 1.
properties

PropertiesCollection

Propriétés personnalisées de l’état.
state

GitStatusState

État de l’état.
targetUrl

string

URL avec les détails de l’état.
updatedDate

string (date-time)

Date et heure de la dernière mise à jour de l’état.

Réponses

Nom Type Description
200 OK

GitPullRequestStatus

opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom Description
vso.code_write Accorde la possibilité de lire, de mettre à jour et de supprimer du code source, d’accéder aux métadonnées relatives aux validations, aux ensembles de modifications, aux branches et à d’autres artefacts de contrôle de version. Accorde également la possibilité 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.
vso.code_status Accorde la possibilité de lire et d’écrire l’état de la validation et de la demande de tirage.

Exemples

On iteration
On pull request
With properties

On iteration

Exemple de requête

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=7.1

{
  "iterationId": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-2",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Exemple de réponse

Code d’état:
200 
{
  "iterationId": 1,
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-2",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:26.4429056Z",
  "updatedDate": "2017-09-19T14:50:26.4429056Z",
  "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/2/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

On pull request

Exemple de requête

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=7.1

{
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-4",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Exemple de réponse

Code d’état:
200 
{
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-4",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:25.1680228Z",
  "updatedDate": "2017-09-19T14:50:25.1680228Z",
  "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/1/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

With properties

Exemple de requête

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=7.1

{
  "properties": {
    "sampleId": 7,
    "customInfo": "Custom status information",
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-19T14:50:26.7410146Z"
    },
    "weight": {
      "$type": "System.Double",
      "$value": 1.75
    },
    "bytes": {
      "$type": "System.Byte[]",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "globalId": {
      "$type": "System.Guid",
      "$value": "1e788cb9-9d3d-4dc6-ac05-822092d17f90"
    }
  },
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Exemple de réponse

Code d’état:
200 
{
  "properties": {
    "bytes": {
      "$type": "System.Byte[]",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "customInfo": {
      "$type": "System.String",
      "$value": "Custom status information"
    },
    "globalId": {
      "$type": "System.String",
      "$value": "1e788cb99d3d4dc6ac05822092d17f90"
    },
    "sampleId": {
      "$type": "System.Int32",
      "$value": 7
    },
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-19T14:50:26.74Z"
    },
    "weight": {
      "$type": "System.Double",
      "$value": 1.75
    }
  },
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:26.7780242Z",
  "updatedDate": "2017-09-19T14:50:26.7780242Z",
  "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/3/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’un service/extension affichant l’état de la demande de tirage. L’état peut être associé à une demande de tirage ou à une itération.
GitStatusContext

Contexte d’état qui identifie de manière unique l’état.
GitStatusState

État de l’état.
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 (n’importe quel 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, d’autres primitives sont retunées sous forme de chaîne. Byte[] attendu comme chaîne encodée en base64.
ReferenceLinks

Classe à représenter une collection de liens de référence REST.

GitPullRequestStatus

Object

Cette classe contient les métadonnées d’un service/extension affichant l’état de la demande de tirage. 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 de l’état.
createdBy

IdentityRef

Identité qui a créé l’état.
creationDate

string (date-time)

Date et heure de création de l’état.
description

string

Description de l’état. Décrit généralement l’état actuel de l’état.
id

integer (int32)

Identificateur d’état.
iterationId

integer (int32)

ID de l’itération à laquelle associer l’état. La valeur minimale est 1.
properties

PropertiesCollection

Propriétés personnalisées de l’état.
state

GitStatusState

État de l’état.
targetUrl

string

URL avec les détails de l’état.
updatedDate

string (date-time)

Date et heure de la dernière mise à jour de l’état.

GitStatusContext

Object

Contexte d’état qui identifie de manière unique l’état.

Nom Type Description
genre

string

Genre du statut. En règle générale, le nom du service/outil qui génère l’état peut être vide.
name

string

L’identificateur de nom de l’état ne peut pas être null ou vide.

GitStatusState

Énumération

État de l’état.

Valeur Description
error

État avec une erreur.
failed

Échec de l’état.
notApplicable

L’état n’est pas applicable à l’objet cible.
notSet

État non défini. État par défaut.
pending

État en attente.
succeeded

État réussi.

IdentityRef

Object
Nom Type Description
_links

ReferenceLinks

Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. 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 sur 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 « auto » du dictionnaire IdentityRef « _links »
displayName

string

Il s’agit du nom complet 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éconseillé - 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éconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Déconseillé : 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é : utiliser Domain+PrincipalName à la place
url

string

Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe.

PropertiesCollection

Object

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 (n’importe quel 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, d’autres primitives sont retunées sous forme de chaîne. Byte[] attendu comme chaîne encodée en base64.

Nom Type Description
count

integer (int32)

Nombre de propriétés dans la collection.
item

object

keys

string[]

Jeu de clés dans la collection.
values

string[]

Ensemble de valeurs dans la collection.
Object

Classe à 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 de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.