API REFERENCE · SCHEMA

AppliedDecisionControls schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Immutable decision-time approval configuration. A null appliedControls value on a decision means no historic snapshot is available; current settings are never substituted. Notification recipients and document hosts are excluded.

governanceRevisionRequired
integer

Minimum: 1.

organizationApprovalRequired
object
organizationApproval fields and rules
organizationApproval.requireSecondReviewRequired
boolean

Default: false.

organizationApproval.secondReviewForRequired
string[]

Maximum items: 4. Default: [].

organizationApproval.secondReviewFor item fields

Each array item: string.

Values: "same_identity", "allow", "restrict", "escalate".

organizationApproval.approverRolesRequired
string[]

Minimum items: 1. Maximum items: 3. Default: ["owner","admin","analyst"].

organizationApproval.approverRoles item fields

Each array item: string.

Values: "owner", "admin", "analyst".

Additional fields are not accepted.

restrictedRolesRequired
object
restrictedRoles fields and rules
restrictedRoles.approvalRequired
string[]
restrictedRoles.approval item fields

Each array item: string.

Values: "analyst", "developer", "viewer".

restrictedRoles.productionRequired
string[]
restrictedRoles.production item fields

Each array item: string.

Values: "analyst", "developer", "viewer".

Additional fields are not accepted.

screeningPolicyRequired
object or null

May be null.

screeningPolicy fields and rules

Allowed alternatives

  • Provide screeningPolicy.id and screeningPolicy.version and screeningPolicy.review.
    screeningPolicy.idRequired
    string

    Format: uuid.

    screeningPolicy.versionRequired
    integer

    Minimum: 1.

    screeningPolicy.reviewRequired
    object
    screeningPolicy.review fields and rules
    screeningPolicy.review.requireSecondReviewRequired
    boolean

    Default: false.

    screeningPolicy.review.secondReviewForRequired
    string[]

    Maximum items: 4. Default: [].

    screeningPolicy.review.secondReviewFor item fields

    Each array item: string.

    Values: "same_identity", "allow", "restrict", "escalate".

    screeningPolicy.review.approverRolesRequired
    string[]

    Minimum items: 1. Maximum items: 3. Default: ["owner","admin","analyst"].

    screeningPolicy.review.approverRoles item fields

    Each array item: string.

    Values: "owner", "admin", "analyst".

    Additional fields are not accepted.

    Additional fields are not accepted.

  • null

    May be null.

Additional fields are not accepted.

Use AppliedDecisionControls in a workflow

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides