TeamCity 2021.1 Help

BuildType

Represents a build configuration.

Related Help article: Build Configuration

Properties

FieldData typeAllowed values

id

string

internalId

string

name

string

templateFlag

boolean

type

string

  • regular
  • composite
  • deployment

paused

boolean

uuid

string

description

string

projectName

string

projectId

string

projectInternalId

string

href

string

webUrl

string

inherited

boolean

links

Links

project

Project

templates

BuildTypes

template

BuildType

vcs-root-entries

VcsRootEntries

settings

Properties

parameters

Properties

steps

Steps

features

Features

triggers

Triggers

snapshot-dependencies

SnapshotDependencies

artifact-dependencies

ArtifactDependencies

agent-requirements

AgentRequirements

branches

Branches

builds

Builds

investigations

Investigations

compatibleAgents

Agents

vcsRootInstances

VcsRootInstances

externalStatusAllowed

boolean

locator

string

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.

<buildType description="string" externalStatusAllowed="true" href="string" id="string" inherited="true" internalId="string" locator="string" name="string" paused="true" projectId="string" projectInternalId="string" projectName="string" templateFlag="true" type="string" uuid="string" webUrl="string"> <links count="123"> <link>[[[link...|link.html]]]</link> </links> <project archived="true" description="string" href="string" id="string" internalId="string" locator="string" name="string" parentProjectId="string" parentProjectInternalId="string" parentProjectName="string" uuid="string" webUrl="string"> <links>[[[links...|links.html]]]</links> <parentProject>[[[project...|project.html]]]</parentProject> <readOnlyUI>[[[StateField...|statefield.html]]]</readOnlyUI> <defaultTemplate>[[[buildType...|buildtype.html]]]</defaultTemplate> <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes> <templates>[[[buildTypes...|buildtypes.html]]]</templates> <parameters>[[[properties...|properties.html]]]</parameters> <vcsRoots>[[[vcs-roots...|vcsroots.html]]]</vcsRoots> <projectFeatures>[[[projectFeatures...|projectfeatures.html]]]</projectFeatures> <projects>[[[projects...|projects.html]]]</projects> <cloudProfiles>[[[cloudProfiles...|cloudprofiles.html]]]</cloudProfiles> </project> <templates count="123" href="string" nextHref="string" prevHref="string"> <buildType>[[[buildType...|buildtype.html]]]</buildType> </templates> <template description="string" externalStatusAllowed="true" href="string" id="string" inherited="true" internalId="string" locator="string" name="string" paused="true" projectId="string" projectInternalId="string" projectName="string" templateFlag="true" type="string" uuid="string" webUrl="string"> <links>[[[links...|links.html]]]</links> <project>[[[project...|project.html]]]</project> <templates>[[[buildTypes...|buildtypes.html]]]</templates> <template>[[[buildType...|buildtype.html]]]</template> <vcs-root-entries>[[[vcs-root-entries...|vcsrootentries.html]]]</vcs-root-entries> <settings>[[[properties...|properties.html]]]</settings> <parameters>[[[properties...|properties.html]]]</parameters> <steps>[[[steps...|steps.html]]]</steps> <features>[[[features...|features.html]]]</features> <triggers>[[[triggers...|triggers.html]]]</triggers> <snapshot-dependencies>[[[snapshot-dependencies...|snapshotdependencies.html]]]</snapshot-dependencies> <artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</artifact-dependencies> <agent-requirements>[[[agent-requirements...|agentrequirements.html]]]</agent-requirements> <branches>[[[branches...|branches.html]]]</branches> <builds>[[[builds...|builds.html]]]</builds> <investigations>[[[investigations...|investigations.html]]]</investigations> <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents> <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances> </template> <vcs-root-entries count="123"> <vcs-root-entry>[[[vcs-root-entry...|vcsrootentry.html]]]</vcs-root-entry> </vcs-root-entries> <settings count="123" href="string"> <property>[[[property...|property.html]]]</property> </settings> <parameters count="123" href="string"> <property>[[[property...|property.html]]]</property> </parameters> <steps count="123"> <step>[[[step...|step.html]]]</step> </steps> <features count="123"> <feature>[[[feature...|feature.html]]]</feature> </features> <triggers count="123"> <trigger>[[[trigger...|trigger.html]]]</trigger> </triggers> <snapshot-dependencies count="123"> <snapshot-dependency>[[[snapshot-dependency...|snapshotdependency.html]]]</snapshot-dependency> </snapshot-dependencies> <artifact-dependencies count="123" replace="string"> <artifact-dependency>[[[artifact-dependency...|artifactdependency.html]]]</artifact-dependency> </artifact-dependencies> <agent-requirements count="123"> <agent-requirement>[[[agent-requirement...|agentrequirement.html]]]</agent-requirement> </agent-requirements> <branches count="123" href="string"> <branch>[[[branch...|branch.html]]]</branch> </branches> <builds count="123" href="string" nextHref="string" prevHref="string"> <build>[[[build...|build.html]]]</build> </builds> <investigations count="123" href="string" nextHref="string" prevHref="string"> <investigation>[[[investigation...|investigation.html]]]</investigation> </investigations> <compatibleAgents count="123" href="string" nextHref="string" prevHref="string"> <agent>[[[agent...|agent.html]]]</agent> </compatibleAgents> <vcsRootInstances count="123" href="string" nextHref="string" prevHref="string"> <vcs-root-instance>[[[vcs-root-instance...|vcsrootinstance.html]]]</vcs-root-instance> </vcsRootInstances> </buildType>
{ "template" : "[[[buildType...|buildtype.html]]]", "paused" : true, "description" : "description", "project" : "[[[project...|project.html]]]", "investigations" : "[[[investigations...|investigations.html]]]", "templateFlag" : true, "type" : "regular", "uuid" : "uuid", "projectInternalId" : "projectInternalId", "internalId" : "internalId", "features" : "[[[features...|features.html]]]", "builds" : "[[[builds...|builds.html]]]", "links" : "[[[links...|links.html]]]", "id" : "id", "href" : "href", "settings" : "[[[properties...|properties.html]]]", "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]", "templates" : "[[[buildTypes...|buildtypes.html]]]", "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]", "compatibleAgents" : "[[[agents...|agents.html]]]", "triggers" : "[[[triggers...|triggers.html]]]", "branches" : "[[[branches...|branches.html]]]", "steps" : "[[[steps...|steps.html]]]", "externalStatusAllowed" : true, "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]", "webUrl" : "webUrl", "inherited" : true, "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]", "name" : "name", "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]", "projectName" : "projectName", "projectId" : "projectId", "parameters" : "[[[properties...|properties.html]]]", "locator" : "locator" }
Last modified: 25 May 2021