ApprovalInfo

Represents approval status for this build, if applicable.

Properties

Field	Data type	Allowed values
`timeoutTimestamp`	`string`
`configurationValid`	`boolean`
`userApprovals`	`UserApprovals`
`groupApprovals`	`GroupApprovals`
`canBeApprovedByCurrentUser`	`boolean`
`approvalReasons`	`List<ApprovableBuild>`
`buildChainBuilds`	`List<BuildsWithReason>`
`status`	`string`	`waitingForApproval` `approved` `timedOut` `canceled`

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.

<approvalInfo canBeApprovedByCurrentUser="true" configurationValid="true" status="string" timeoutTimestamp="string">
  <userApprovals count="123">
    <userApproval>[[[userApprovalRule...|userapprovalrule.html]]]</userApproval>
  </userApprovals>
  <groupApprovals count="123">
    <groupApproval>[[[groupApprovalRule...|groupapprovalrule.html]]]</groupApproval>
  </groupApprovals>
  <approvalReasons>[[[approvableBuild...|approvablebuild.html]]]</approvalReasons>
  <buildChainBuilds>[[[buildsWithReason...|buildswithreason.html]]]</buildChainBuilds>
</approvalInfo>

{
  "configurationValid" : true,
  "userApprovals" : {
    "userApproval" : [ {
      "approved" : true,
      "user" : "[[[user...|user.html]]]"
    } ],
    "count" : 5
  },
  "timeoutTimestamp" : "timeoutTimestamp",
  "approvalReasons" : [ {
    "buildTypeId" : "buildTypeId",
    "buildTypeName" : "buildTypeName",
    "buildId" : "buildId"
  } ],
  "buildChainBuilds" : [ {
    "builds" : [ {
      "buildTypeId" : "buildTypeId",
      "buildTypeName" : "buildTypeName",
      "buildId" : "buildId"
    } ],
    "approvalReason" : {
      "buildTypeId" : "buildTypeId",
      "buildTypeName" : "buildTypeName",
      "buildId" : "buildId"
    }
  } ],
  "canBeApprovedByCurrentUser" : true,
  "groupApprovals" : {
    "count" : 1,
    "groupApproval" : [ {
      "requiredApprovalsCount" : 4,
      "currentlyApprovedBy" : "[[[users...|users.html]]]",
      "group" : "[[[group...|group.html]]]"
    } ]
  },
  "status" : "waitingForApproval"
}

Last modified: 14 March 2025