Interface ApprovalConfiguration

The approval configuration of a status within a workflow. Applies only to Jira Service Management approvals.

interface ApprovalConfiguration {
    active: "false" | "true";
    conditionType: "number" | "percent" | "numberPerPrincipal";
    conditionValue: string;
    exclude?: null | "assignee" | "reporter";
    fieldId: string;
    prePopulatedFieldId?: null | string;
    transitionApproved: string;
    transitionRejected: string;
}

Properties

active conditionType conditionValue exclude? fieldId prePopulatedFieldId? transitionApproved transitionRejected

Properties

active

active: "false" | "true"

Whether the approval configuration is active.

conditionType

conditionType: "number" | "percent" | "numberPerPrincipal"

How the required approval count is calculated. It may be configured to require a specific number of approvals, or approval by a percentage of approvers. If the approvers source field is Approver groups, you can configure how many approvals per group are required for the request to be approved. The number will be the same across all groups.

conditionValue

conditionValue: string

The number or percentage of approvals required for a request to be approved. If conditionType is number, the value must be 20 or less. If conditionType is percent, the value must be 100 or less.

Optionalexclude

exclude?: null | "assignee" | "reporter"

A list of roles that should be excluded as possible approvers.

fieldId

fieldId: string

The custom field ID of the "Approvers" or "Approver Groups" field.

OptionalprePopulatedFieldId

prePopulatedFieldId?: null | string

The custom field ID of the field used to pre-populate the Approver field. Only supports the "Affected Services" field.

transitionApproved

transitionApproved: string

The numeric ID of the transition to be executed if the request is approved.

transitionRejected

transitionRejected: string

The numeric ID of the transition to be executed if the request is declined.

Settings

Member Visibility

On This Page

Properties