Refs - Update Refs

Référence

Service:: Git

API Version:: 5.0

Création, mise à jour ou suppression de refs(branches).

La mise à jour d’une ref signifie qu’elle pointe vers un commit différent de celui d’avant. Vous devez spécifier l’ancien et le nouveau commit pour éviter les conditions de course.

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?api-version=5.0

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?projectId={projectId}&api-version=5.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
repositoryId	path	True	string	Nom ou ID du dépôt.
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.
projectId	query		string	ID ou nom du projet d’équipe. Facultatif si vous spécifiez un ID pour le dépôt.

Corps de la demande

Nom	Type	Description
body	GitRefUpdate[]	Liste des mises à jour de référence à effectuer

Réponses

Nom	Type	Description
200 OK	GitRefUpdateResult[]	opération réussie

Sécurité

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nom	Description
vso.code_write	Permet de lire, de mettre à jour et de supprimer le code source, d’accéder aux métadonnées relatives aux commits, aux ensembles de modifications, aux branches et à d’autres artefacts de contrôle de version. Permet également de créer et de gérer des demandes de tirage et des révisions de code, et de recevoir des notifications sur les événements de contrôle de version via des hooks de service.

Nom

Description

vso.code_write

Permet de lire, de mettre à jour et de supprimer le code source, d’accéder aux métadonnées relatives aux commits, aux ensembles de modifications, aux branches et à d’autres artefacts de contrôle de version. Permet également de créer et de gérer des demandes de tirage et des révisions de code, et de recevoir des notifications sur les événements de contrôle de version via des hooks de service.

Exemples

Create/Update/Delete a ref by repositoryId

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?api-version=5.0

[
  {
    "name": "refs/heads/vsts-api-sample/answer-woman-flame",
    "oldObjectId": "0000000000000000000000000000000000000000",
    "newObjectId": "ffe9cba521f00d7f60e322845072238635edb451"
  }
]

Sample Response

Status code:: 200

transfer-Encoding: chunked

Response Body

{
  "value": [
    {
      "repositoryId": "d3d1760b-311c-4175-a726-20dfc6a7f885",
      "name": "refs/heads/vsts-api-sample/answer-woman-flame",
      "oldObjectId": "0000000000000000000000000000000000000000",
      "newObjectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "isLocked": false,
      "updateStatus": "succeeded",
      "success": true
    }
  ],
  "count": 1
}

Définitions

Nom	Description
GitRefUpdate
GitRefUpdateResult
GitRefUpdateStatus	État de la mise à jour à partir du serveur TFS.

GitRefUpdate

Nom	Type	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitRefUpdateResult

Nom	Type	Description
customMessage	string	Message personnalisé pour l’objet de résultat Pour instance, Raison de l’échec.
isLocked	boolean	Si la référence est verrouillée ou non
name	string	Nom de la référence
newObjectId	string	Nouvel ID d’objet
oldObjectId	string	Ancien ID d’objet
rejectedBy	string	Nom du plug-in qui a rejeté la mise à jour.
repositoryId	string	ID du dépôt
success	boolean	True si la mise à jour de référence a réussi, false sinon
updateStatus	GitRefUpdateStatus	État de la mise à jour à partir du serveur TFS.

GitRefUpdateStatus

État de la mise à jour à partir du serveur TFS.

Nom	Type	Description
createBranchPermissionRequired	string	La demande de mise à jour de référence n’a pas pu être effectuée, car l’utilisateur n’a pas l’autorisation de créer une branche
createTagPermissionRequired	string	La demande de mise à jour ref n’a pas pu être effectuée, car l’utilisateur n’a pas l’autorisation de créer une balise
forcePushRequired	string	Indique que la demande de mise à jour de référence n’a pas pu être effectuée, car une partie du graphique serait déconnectée par cette modification et que l’appelant ne dispose pas de l’autorisation ForcePush sur le dépôt.
invalidRefName	string	Indique que la demande de mise à jour de ref n’a pas pu être effectuée, car le nom de référence présenté dans la demande n’était pas valide.
locked	string	La mise à jour de la référence n’a pas pu être effectuée, car la ref est verrouillée par un autre utilisateur.
manageNotePermissionRequired	string	La demande de mise à jour de référence n’a pas pu être effectuée, car l’utilisateur n’a pas les autorisations de création de notes requises pour écrire cette note
refNameConflict	string	La mise à jour de ref n’a pas pu être effectuée, car, en mode non respectant la casse, le nom de la référence est en conflit avec un nom de référence existant, différemment cassé.
rejectedByPlugin	string	La mise à jour de référence n’a pas pu être effectuée, car elle a été rejetée par le plug-in.
rejectedByPolicy	string	La mise à jour de référence n’a pas pu être effectuée, car elle a été rejetée par la stratégie.
staleOldObjectId	string	Indique que la demande de mise à jour ref n’a pas pu être effectuée, car l’ancien ID d’objet présenté dans la demande n’était pas l’ID d’objet de la ref lorsque la base de données a tenté la mise à jour. Le scénario le plus probable est que l’appelant a perdu une course pour mettre à jour la référence.
succeeded	string	Indique que la demande de mise à jour de référence a été effectuée avec succès.
succeededCorruptRef	string	Indique que la demande de mise à jour de référence a été effectuée correctement, mais que la référence passée a été endommagée. Comme dans, l’ancien ID d’objet était incorrect. Cela ne doit se produire que pendant les suppressions.
succeededNonExistentRef	string	Indique que la demande de mise à jour de référence a été effectuée avec succès, mais que la ref n’existe pas, donc aucune modification n’a été apportée. Cela ne doit se produire que pendant les suppressions.
unprocessed	string	La demande n’a pas été traitée
unresolvableToCommit	string	Impossible de terminer la demande de mise à jour ref, car le nouvel ID d’objet de la ref n’a pas pu être résolu en objet commit (potentiellement par le biais d’un nombre quelconque de balises)
writePermissionRequired	string	Impossible de terminer la demande de mise à jour ref, car l’utilisateur n’a pas les autorisations d’écriture requises pour écrire cette ref

Partager via