GroupApprovalRule
A group approval rule and its current status for the given build.
Properties
group
A user group whose users need to approve the target build.
currentlyApprovedBy
The list of TeamCity users in the group who already approved the build.
requiredApprovalsCount
The number of TeamCity users in the group required to approve the queued 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.
<groupApprovalRule requiredApprovalsCount="3">
<group description="Contains all TeamCity users" href="/app/rest/userGroups/key:ALL_USERS_GROUP" key="ALL_USERS_GROUP" name="All Users">
<parent-groups>[[[groups...|groups.html]]]</parent-groups>
<child-groups>[[[groups...|groups.html]]]</child-groups>
<users>[[[users...|users.html]]]</users>
<roles>[[[roleAssignments...|roleassignments.html]]]</roles>
<properties>[[[properties...|properties.html]]]</properties>
</group>
<currentlyApprovedBy count="12">
<user>[[[user...|user.html]]]</user>
</currentlyApprovedBy>
</groupApprovalRule>
{
"requiredApprovalsCount" : 3,
"currentlyApprovedBy" : "[[[users...|users.html]]]",
"group" : "[[[group...|group.html]]]"
}
Last modified: 04 April 2026