BuildTriggerCustomization

Passed to the Trigger.buildCustomization property to trigger a customized build.

Properties

enforceCleanCheckout

Returns true if the agent should clear the build checkout directory before checking out sources from the VCS; otherwise, false.

enforceCleanCheckoutForDependencies

Returns true if the enforceCleanCheckout behavior should all apply to all snapshot dependencies of this build; otherwise, false.

parameters

The list of customized properties for the build started by this trigger.

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.

<BuildTriggerCustomization enforceCleanCheckout="true" enforceCleanCheckoutForDependencies="false">
  <parameters count="3" href="/app/rest/buildTypes/id:MyBuild/parameters">
    <property>[[[property...|property.html]]]</property>
  </parameters>
</BuildTriggerCustomization>

{
  "enforceCleanCheckout" : true,
  "enforceCleanCheckoutForDependencies" : false,
  "parameters" : {
    "count" : 3,
    "property" : [ {
      "inherited" : false,
      "name" : "my.build.param",
      "type" : "[[[type...|type.html]]]",
      "value" : "production"
    } ],
    "href" : "/app/rest/buildTypes/id:MyBuild/parameters"
  }
}

Last modified: 18 August 2026