BuildType
A build configuration owned by a TeamCity project, or a template created from this configuration. Spawns builds to execute configured build steps.
Related Help article: Build Configuration
Properties
id
The build configuration ID. Typically consists of a trunkated project and configuration names in the ProjectName_ConfigurationName format.
internalId
The automatically generated build configuration ID. This is the internal property and is not intented to be used.
name
The public build configuration name displayed in TeamCity UI.
templateFlag
Returns true if the current BuildType entity is a build configuration template; false if this is a regular build configuration. Inspect the templates field to view all templates attached to the target configuration.
type
The build configuration type:
regular — a regular build configuration.
composite — a composite configuration that aggregates results of multiple upstream build chain configurations.
deployment — a deployment build configuration.
See Changing build configuration type for more information.
paused
Returns true if a configuration is paused and cannot start new builds automatically upon build trigger requests; otherwise, false. To pause or unpause a configuration, use the configuration's Actions menu in TeamCity UI or send a PUT request with the required Boolean value to the /app/rest/buildTypes/_build_type_locator_/paused endpoint.
uuid
An internally used universally unique identifier.
description
The custom build configuration description, or null if not set.
projectName
The public name of a parent TeamCity project.
projectId
The ID of a parent TeamCity project that owns this build configuration.
projectInternalId
The automatically generated ID of a parent project. This is the internal property and is not intented to be used.
href
The short link (without the address of a TeamCity server) to this build configuration.
webUrl
The regular URL for this build configuration or template.
inherited
Returns null for build configurations, true for configuration templates inherited from other templates, and false for regular templates extracted from build configurations. You can only create templates inherited from other base templates in Kotlin.
links
URL links for editing and viewing this build configuration.
project
The project that owns this build configuration or template.
templates
The list of all build configuration templates currently attached to this build configuration.
template
The first template from the templates collection. This field is only in effect for older versions of TeamCity where only one template could be attached to a build configuration.
vcs-root-entries
A collection of VcsEntry objects, which store attached VcsRoot objects coupled with their unique checkout rules for this build configuration.
settings
The list of build configuration settings. For example, its branch filter, current build number counter, and others.
parameters
The list of input parameters. Input parameters are designed to be used directly in their parent configuration. Includes parameters inherited from configuration's parent project(s).
output-parameters
The list of output parameters. Output parameters can be accessed by other configurations within the same build chain via the dep.config_id.parameter_name syntax. Does not duplicate the list of input parameters if the All parameters are available to other build configurations setting of a configuration is enabled.
steps
The list of enabled and disabled build steps owned by this configuration.
features
The list of enabled and disabled build features added to this configuration.
triggers
The list of build triggers configured in this configuration. Build triggers allow configurations to automatically start new builds when specific conditions are met. Triggers do not launch new builds for paused configurations.
snapshot-dependencies
The list of snapshot dependencies that specify which configurations must finish their builds before this configuration can run its build.
artifact-dependencies
The list of artifact dependencies that specify which files published by other build configurations must be imported to this configuration.
agent-requirements
The list of agent requirements that specify which build agents are eligible to run builds of this configuration. Does not include implicit build steps requirements.
branches
The list of repository branches that can be built in this build configuration. Supported branches are specified by the branch specs of attached VCS roots, and then filtered by configuration's branch filter (buildType.settings.branchFilter).
builds
Stores all builds spawned from this build configuration.
investigations
Stores active investigations for a build configuration. Note that this list stores investigations assigned on a build configuration level, and does not include investigations of individual build problems assigned from the build results page.
compatibleAgents
The list of build agents that are eligible to run builds of this configuration.
compatibleCloudImages
The list of cloud images that can spawn build agents eligible to run builds of this configuration.
vcsRootInstances
A collection of VcsRootInstance objects, which store customized clones of a VcsRoot.
externalStatusAllowed
This is the internal property and is not intented to be used.
pauseComment
A Comment entity storing the TeamCity user, date, and optional note for the last pause or unpause action on this configuration.
locator
Schema
Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.
A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.