Passer à la navigation

Mettre à jour la branche de l’agent

Met à jour les propriétés de la branche de l’agent, telles que le nom, la description, le statut d’archivage, le niveau de protection et le rebasage automatique sur main

Paramètres de chemin

agent_idstringRequis

L’ID d’un agent. Il est renvoyé lors de la création de l’agent.

branch_idstringRequis
Identifiant unique de la branche.

En-têtes

xi-api-keystringOptionnel

Requête

This endpoint expects an object.
namestring or nullOptionnel1-140 characters

Nouveau nom de la branche. Il doit être unique au sein de l’agent.

descriptionstring or nullOptionnel<=4096 characters

Nouvelle description de la branche. Transmettez une chaîne vide pour l’effacer.

is_archivedboolean or nullOptionnel

Indique si la branche doit être archivée

protection_statusenum or nullOptionnelPar défaut writer_perms_required
Le niveau de protection de la branche
Valeurs autorisées:
auto_rebaseboolean or nullOptionnel

Lorsque la valeur est true, rebase automatiquement cette branche sur la branche principale après chaque nouvelle version principale. Ne peut pas être activé sur la branche principale.

Réponse

Réponse réussie

idstring
namestring
agent_idstring
descriptionstring
created_atinteger
last_committed_atinteger
is_archivedboolean
protection_statusenumOptionnelPar défaut writer_perms_required
Valeurs autorisées:
auto_rebasebooleanOptionnelPar défaut false
access_infoobject or nullOptionnel

Informations d’accès à la branche

current_live_percentagedoubleOptionnelPar défaut 0
Pourcentage du trafic actif sur la branche
parent_branchobject or nullOptionnel
Branche parente de la branche
most_recent_versionslist of objectsOptionnel

Versions les plus récentes de la branche

Erreurs

422
Unprocessable Entity Error