DeliveryCondition
A condition of a gate.
Properties
idstring requiredThe ID of the condition.namestring requiredThe name of the condition.kindenum requiredThe kind of the condition:approval,decision, ormanual.Values:approval,decision,manualstateenum requiredThe state of the condition:pending,satisfiedorrejected.Values:pending,satisfied,rejectedactorKindenum optionalWho satisfied or rejected the condition.Values:user,webhook,system,triggeractorstring optionalThe login of the user who satisfied or rejected the condition.descriptionstring optionalWhat the condition is for, as the pipeline program describes it.- Whether the caller can continue a manual condition.
- ↳
allowedboolean requiredWhether the caller can do the action now. - ↳
reasonstring optionalWhy the caller cannot do the action. Not set when it is allowed. - Whether the caller can approve or reject an approval condition. Only an eligible approver of its change request can.
- ↳
allowedboolean requiredWhether the caller can do the action now. - ↳
reasonstring optionalWhy the caller cannot do the action. Not set when it is allowed. commentstring optionalThe comment of the person who continued a manual condition.changeRequestIdstring optionalThe ID of the change request of an approval.changeRequestStatusstring optionalThe status of the change request of an approval:draft,pending,ready,appliedorclosed.requiredApprovalsinteger optionalThe number of approvals that an approval condition needs.approvalsinteger optionalThe number of approvals that count now.eligibleApproversarray[string] optionalThe names of the users and teams that can approve. Empty means anyone with the pipeline:approve permission on the pipeline stack.detailsmap[string]object optionalFacts about the condition. For an approval, the message that says why it cannot get its change request. For a decision, the outcome and answers of its last evaluation, or the message of its last failure and the time of the next attempt.