BuildTriggeringOptions

Represents the dependency/queue settings with which this build has been started.

Properties

Field	Data type	Description
`cleanSources`	`boolean`	If `true`, all files in the build checkout directory will be cleaned before this build.
`cleanSourcesInAllDependencies`	`boolean`	If `true`, all builds that belong to this build chain clean their build checkout directories before the build starts.
`rebuildAllDependencies`	`boolean`	If `true`, all dependencies of this build will be rebuilt. Use the `rebuildFailedOrIncompleteDependencies` field to specify whether only successful dependencies should be rebuilt.
`rebuildFailedOrIncompleteDependencies`	`boolean`	If `true`, all dependencies (including failed and incomplete) will be rebuilt when this build is triggered. Otherwise, only successful dependencies will be rebuilt.
`queueAtTop`	`boolean`	If `true`, the build will be placed at the top of the building queue.
`freezeSettings`	`boolean`	If `true`, project settings will be locked when a build starts. If settings are changed when the build is already in the building queue, the current build will not be updated.
`tagDependencies`	`boolean`	If `true`, tags specified in Tag and Tags fields will be applied to builds and dependencies.
`rebuildDependencies`	`BuildTypes`	The list of rebuilt dependencies.

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.

<buildTriggeringOptions cleanSources="true" cleanSourcesInAllDependencies="true" freezeSettings="true" queueAtTop="true" rebuildAllDependencies="true" rebuildFailedOrIncompleteDependencies="true" tagDependencies="true">
  <rebuildDependencies count="123" href="string" nextHref="string" prevHref="string">
    <buildType>[[[buildType...|buildtype.html]]]</buildType>
  </rebuildDependencies>
</buildTriggeringOptions>

{
  "cleanSources" : true,
  "rebuildFailedOrIncompleteDependencies" : true,
  "queueAtTop" : true,
  "cleanSourcesInAllDependencies" : true,
  "rebuildDependencies" : {
    "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
    "count" : 4,
    "prevHref" : "prevHref",
    "href" : "href",
    "nextHref" : "nextHref"
  },
  "tagDependencies" : true,
  "rebuildAllDependencies" : true,
  "freezeSettings" : true
}

Last modified: 13 March 2023