NewBuildTypeDescription

A stub object that represents a newly created build configuration (build type). Objects of the NewBuildTypeDescription type can be used to do the following:

Copy an existing build configurations. POST a NewBuildTypeDescription object with the specified sourceBuildType property to the /app/rest/projects/_target_project_locator_/buildTypes endpoint.
Create a new build configurations and templates. POST a NewBuildTypeDescription object with required properties (name is required) to the /app/rest/projects/_parent_project_locator_/buildTypes or /app/rest/projects/_parent_project_locator_/templates endpoint.

Properties

copyAllAssociatedSettings

Returns true if all settings of a cloned configuration or template should be copied; otherwise, false.

projectsIdsMap

This is the internal property that is not intended to be used

buildTypesIdsMap

This is the internal property that is not intended to be used

vcsRootsIdsMap

This is the internal property that is not intended to be used

name

The public name of a build configuration or template.

id

The ID of a build configuration or a template.

sourceBuildTypeLocator

This property is deprecated, use sourceBuildType instead.

sourceBuildType

The source build type. Used when copying existing build configurations and templates.

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.

<newBuildTypeDescription copyAllAssociatedSettings="true" id="My_Build_Config_ID" name="My Build Config" sourceBuildTypeLocator="deprecated">
  <projectsIdsMap count="123" href="string">
    <property>[[[property...|property.html]]]</property>
  </projectsIdsMap>
  <buildTypesIdsMap count="123" href="string">
    <property>[[[property...|property.html]]]</property>
  </buildTypesIdsMap>
  <vcsRootsIdsMap count="123" href="string">
    <property>[[[property...|property.html]]]</property>
  </vcsRootsIdsMap>
  <sourceBuildType description="Deploys artifacts to the public registry" externalStatusAllowed="false" href="/app/rest/buildTypes/id:Deployments_DeployToGlobal" id="Deployments_DeployToGlobal" inherited="false" internalId="bt1057" locator="string" name="Deploy To Global" paused="false" projectId="Deployments" projectInternalId="project762" projectName="Deployments" templateFlag="false" type="regular" uuid="8e7eafb8-321b-456e-84db-e73714c8fa3f" webUrl="https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds">
    <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>
    <output-parameters>[[[properties...|properties.html]]]</output-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>
    <compatibleCloudImages>[[[cloudImages...|cloudimages.html]]]</compatibleCloudImages>
    <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances>
    <pauseComment>[[[comment...|comment.html]]]</pauseComment>
  </sourceBuildType>
</newBuildTypeDescription>

{
  "buildTypesIdsMap" : {
    "count" : 1,
    "property" : [ {
      "inherited" : true,
      "name" : "name",
      "type" : "[[[type...|type.html]]]",
      "value" : "value"
    } ],
    "href" : "href"
  },
  "sourceBuildTypeLocator" : "deprecated",
  "name" : "My Build Config",
  "projectsIdsMap" : {
    "count" : 1,
    "property" : [ {
      "inherited" : true,
      "name" : "name",
      "type" : "[[[type...|type.html]]]",
      "value" : "value"
    } ],
    "href" : "href"
  },
  "vcsRootsIdsMap" : {
    "count" : 1,
    "property" : [ {
      "inherited" : true,
      "name" : "name",
      "type" : "[[[type...|type.html]]]",
      "value" : "value"
    } ],
    "href" : "href"
  },
  "sourceBuildType" : {
    "template" : "[[[buildType...|buildtype.html]]]",
    "paused" : false,
    "output-parameters" : "[[[properties...|properties.html]]]",
    "description" : "Deploys artifacts to the public registry",
    "project" : "[[[project...|project.html]]]",
    "investigations" : "[[[investigations...|investigations.html]]]",
    "templateFlag" : false,
    "type" : "regular",
    "uuid" : "8e7eafb8-321b-456e-84db-e73714c8fa3f",
    "projectInternalId" : "project762",
    "internalId" : "bt1057",
    "features" : "[[[features...|features.html]]]",
    "builds" : "[[[builds...|builds.html]]]",
    "links" : "[[[links...|links.html]]]",
    "id" : "Deployments_DeployToGlobal",
    "href" : "/app/rest/buildTypes/id:Deployments_DeployToGlobal",
    "compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]",
    "settings" : "[[[properties...|properties.html]]]",
    "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]",
    "templates" : "[[[buildTypes...|buildtypes.html]]]",
    "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]",
    "compatibleAgents" : "[[[agents...|agents.html]]]",
    "pauseComment" : "[[[comment...|comment.html]]]",
    "triggers" : "[[[triggers...|triggers.html]]]",
    "branches" : "[[[branches...|branches.html]]]",
    "steps" : "[[[steps...|steps.html]]]",
    "externalStatusAllowed" : false,
    "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]",
    "webUrl" : "https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds",
    "inherited" : false,
    "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]",
    "name" : "Deploy To Global",
    "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]",
    "projectName" : "Deployments",
    "projectId" : "Deployments",
    "parameters" : "[[[properties...|properties.html]]]",
    "locator" : "locator"
  },
  "id" : "My_Build_Config_ID",
  "copyAllAssociatedSettings" : true
}

Last modified: 02 December 2025