BuildType
Represents a build configuration.
Related Help article: Build Configuration
Field | Data type | Allowed values |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
| ||
| ||
|
| |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
|
| |
| ||
|
|
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>
</links>
<project archived="true" description="string" href="string" id="string" internalId="string" locator="string" name="string" parentProjectId="string" parentProjectInternalId="string" parentProjectName="string" uuid="string" virtual="true" webUrl="string">
<links>links...</links>
<parentProject>project...</parentProject>
<readOnlyUI>StateField...</readOnlyUI>
<defaultTemplate>buildType...</defaultTemplate>
<buildTypes>buildTypes...</buildTypes>
<templates>buildTypes...</templates>
<deploymentDashboards>deploymentDashboards...</deploymentDashboards>
<parameters>properties...</parameters>
<vcsRoots>vcs-roots...</vcsRoots>
<projectFeatures>projectFeatures...</projectFeatures>
<projects>projects...</projects>
<cloudProfiles>cloudProfiles...</cloudProfiles>
<ancestorProjects>projects...</ancestorProjects>
</project>
<templates count="123" href="string" nextHref="string" prevHref="string">
<buildType>buildType...</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>
<project>project...</project>
<templates>buildTypes...</templates>
<template>buildType...</template>
<vcs-root-entries>vcs-root-entries...</vcs-root-entries>
<settings>properties...</settings>
<parameters>properties...</parameters>
<steps>steps...</steps>
<features>features...</features>
<triggers>triggers...</triggers>
<snapshot-dependencies>snapshot-dependencies...</snapshot-dependencies>
<artifact-dependencies>artifact-dependencies...</artifact-dependencies>
<agent-requirements>agent-requirements...</agent-requirements>
<branches>branches...</branches>
<builds>builds...</builds>
<investigations>investigations...</investigations>
<compatibleAgents>agents...</compatibleAgents>
<compatibleCloudImages>cloudImages...</compatibleCloudImages>
<vcsRootInstances>vcs-root-instances...</vcsRootInstances>
<pauseComment>comment...</pauseComment>
</template>
<vcs-root-entries count="123">
<vcs-root-entry>vcs-root-entry...</vcs-root-entry>
</vcs-root-entries>
<settings count="123" href="string">
<property>property...</property>
</settings>
<parameters count="123" href="string">
<property>property...</property>
</parameters>
<steps count="123">
<step>step...</step>
</steps>
<features count="123">
<feature>feature...</feature>
</features>
<triggers count="123">
<trigger>trigger...</trigger>
</triggers>
<snapshot-dependencies count="123">
<snapshot-dependency>snapshot-dependency...</snapshot-dependency>
</snapshot-dependencies>
<artifact-dependencies count="123" replace="string">
<artifact-dependency>artifact-dependency...</artifact-dependency>
</artifact-dependencies>
<agent-requirements count="123">
<agent-requirement>agent-requirement...</agent-requirement>
</agent-requirements>
<branches count="4" href="/app/rest/buildTypes/MyProject_MyBuildConfig/branches">
<branch>branch...</branch>
</branches>
<builds count="12" href="/app/rest/builds?locator=buildType:Project_Config&fields=count,href" nextHref="/app/rest/builds?locator=count:200,start:250,state:finished" prevHref="/app/rest/builds?locator=count:50,start:0,state:finished">
<build>build...</build>
</builds>
<investigations count="123" href="string" nextHref="string" prevHref="string">
<investigation>investigation...</investigation>
</investigations>
<compatibleAgents count="123" href="string" nextHref="string" prevHref="string">
<agent>agent...</agent>
</compatibleAgents>
<compatibleCloudImages count="123" href="string" nextHref="string" prevHref="string">
<cloudImage>cloudImage...</cloudImage>
</compatibleCloudImages>
<vcsRootInstances count="123" href="string" nextHref="string" prevHref="string">
<vcs-root-instance>vcs-root-instance...</vcs-root-instance>
</vcsRootInstances>
<pauseComment text="string" timestamp="string">
<user>user...</user>
</pauseComment>
</buildType>
{
"template" : "buildType...",
"paused" : true,
"description" : "description",
"project" : "project...",
"investigations" : "investigations...",
"templateFlag" : true,
"type" : "regular",
"uuid" : "uuid",
"projectInternalId" : "projectInternalId",
"internalId" : "internalId",
"features" : "features...",
"builds" : "builds...",
"links" : "links...",
"id" : "id",
"href" : "href",
"compatibleCloudImages" : "cloudImages...",
"settings" : "properties...",
"vcsRootInstances" : "vcs-root-instances...",
"templates" : "buildTypes...",
"artifact-dependencies" : "artifact-dependencies...",
"compatibleAgents" : "agents...",
"pauseComment" : "comment...",
"triggers" : "triggers...",
"branches" : "branches...",
"steps" : "steps...",
"externalStatusAllowed" : true,
"agent-requirements" : "agent-requirements...",
"webUrl" : "webUrl",
"inherited" : true,
"snapshot-dependencies" : "snapshot-dependencies...",
"name" : "name",
"vcs-root-entries" : "vcs-root-entries...",
"projectName" : "projectName",
"projectId" : "projectId",
"parameters" : "properties...",
"locator" : "locator"
}
Thanks for your feedback!