TeamCity REST API Reference 2025.11 Help

CompositeApprovalRule

A composite approval rule that combines user groups and/or individual users into a single entity with a shared vote count.

Related Help article: Build Approval Settings

Properties

requiredApprovalsCount

The number of TeamCity user approvals required to start this build. These can be any users that belong to either users or groups lists.

groups

The list of groups whose users can approve the corresponding build.

users

The list of users who can approve the corresponding build.

currentlyApprovedBy

The current number of users who already approved this build.

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.

<compositeApprovalRule requiredApprovalsCount="4"> <groups>[[[group...|group.html]]]</groups> <users>[[[user...|user.html]]]</users> <currentlyApprovedBy count="12"> <user>[[[user...|user.html]]]</user> </currentlyApprovedBy> </compositeApprovalRule>
{ "requiredApprovalsCount" : 4, "groups" : [ "[[[group...|group.html]]]" ], "currentlyApprovedBy" : "[[[users...|users.html]]]", "users" : [ "[[[user...|user.html]]]" ] }
Last modified: 02 December 2025