MatrixConfiguration

Stores unique matrix build settings. Matrix builds are virtual builds spawned by build configurations with the Matrix Build feature. This object is accessible via the build.matrixConfiguration field.

Properties

default

This is the internal property and is not intended to be used.

parameters

The collection of all parameters and their values configured in the Matrix Build feature.

enabled

Returns true if the build feature is enabled; otherwise, false.

dependencies

Stores all combinations of parameter values and virtual builds that processed these combinations.

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.

<MatrixConfiguration default="false" enabled="true">
  <parameters count="123" groupArtifacts="true" id="string">
    <parameters>[[[MatrixParameterDescriptor...|matrixparameterdescriptor.html]]]</parameters>
  </parameters>
  <dependencies count="7">
    <dependency>[[[MatrixDependency...|matrixdependency.html]]]</dependency>
  </dependencies>
</MatrixConfiguration>

{
  "default" : false,
  "parameters" : {
    "groupArtifacts" : true,
    "count" : 8,
    "id" : "id",
    "parameters" : [ {
      "valueCount" : 7,
      "name" : "name",
      "value" : [ "[[[LabeledValue...|labeledvalue.html]]]" ]
    } ]
  },
  "enabled" : true,
  "dependencies" : {
    "dependency" : [ {
      "build" : "[[[build...|build.html]]]",
      "parameters" : "[[[entries...|entries.html]]]"
    } ],
    "count" : 7
  }
}

Last modified: 02 December 2025