Hoppa till navigering

Uppdatera agentgren

Uppdatera egenskaper för agentgrenen, såsom namn, beskrivning, arkiveringsstatus, skyddsnivå och automatisk rebase till main

Sökvägsparametrar

agent_idstringObligatorisk

ID:t för en agent. Det returneras när agenten skapas.

branch_idstringObligatorisk

Unik identifierare för grenen.

Headers

xi-api-keystringValfri

Förfrågan

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

Nytt namn på grenen. Måste vara unikt inom agenten.

descriptionstring or nullValfri<=4096 characters

Ny beskrivning för grenen. Skicka en tom sträng för att rensa den.

is_archivedboolean or nullValfri
Om grenen ska arkiveras
protection_statusenum or nullValfriStandard är writer_perms_required

Skyddsnivån för grenen

Tillåtna värden:
auto_rebaseboolean or nullValfri

När värdet är true rebasas den här grenen automatiskt till main efter varje ny huvudversion. Kan inte aktiveras på huvudgrenen.

Svar

Lyckat svar
idstring
namestring
agent_idstring
descriptionstring
created_atinteger
last_committed_atinteger
is_archivedboolean
protection_statusenumValfriStandard är writer_perms_required
Tillåtna värden:
auto_rebasebooleanValfriStandard är false
access_infoobject or nullValfri

Åtkomstinformation för grenen

current_live_percentagedoubleValfriStandard är 0

Procentandel av trafiken som är live på grenen

parent_branchobject or nullValfri

Grenens överordnade gren

most_recent_versionslist of objectsValfri
Senaste versionerna i grenen

Fel

422
Unprocessable Entity Error