Branch object

You can use the Branch object to create, update, and delete development branches on your account.

Structure

<Branch>
  <id/>
  <name/>
  <createdBy/>
  <createdDate/>
  <modifiedBy/>
  <modifiedDate/>
  <parentId/>
  <parentName/>
  <packageId/>
  <ready/>
  <deleted/>
  <stage/>
</Branch>

Field	Type	Description
id	string	The ID of the branch.
name	string	The name of the branch.
createdBy	string	The user who created the branch.
createdDate	dateTime (yyyy-MM-dd'T'HH:mm:ss'Z')	The date and time when the branch was created.
modifiedBy	string	The user who last modified the branch.
modifiedDate	dateTime (yyyy-MM-dd'T'HH:mm:ss'Z')	The date and time when the branch was updated.
parentId	string	The ID of the parent branch.
parentName	string	The name of the parent branch.
packageId	string	The ID of the packaged component from which the branch is created.
ready	boolean	Whether the branch is ready to use.
deleted	boolean	Whether the branch is deleted.
stage	string	The branch status: CREATING, NORMAL (ready for use), or DELETING.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE

Using the DELETE operation

• You can delete branches stuck in a non-ready state (such as CREATING, DELETING, FAILED_TO_CREATE, FAILED_TO_DELETE, and FAILED_TO_MERGE) after the minimum dwell time has passed. The default time is 15 minutes and can be configured using EngineConfig.BRANCH_FORCE_DELETE_MIN_DWELL_MINUTES.

• If the minimum dwell time hasn't passed, the API returns the following message: The {branchName} branch is currently processing. Please try again in {X} minutes.

• If the branch is locked by an active merge request, the API returns the following message: The {branchName} branch is locked. MR-{id} is still processing. Try again soon.

Using the QUERY operation

You must first retrieve the ID of your main branch, using the name of your current branch. If you haven't created any branches, your current branch will be "main". The QUERY operation supports the following query fields:

• id
• name
• parentId
• parentName
• createdBy
• createdDate
• modifiedBy
• modifiedDate

When you query a branch, it might be in one of the following states:

• CREATING - The branch is being created
• NORMAL - The branch is ready to use
• DELETING - The branch is being deleted