Skip to main content

ControlOutcomeType

What a control does when its conditions match: block with a message, require approval, or ask the person to confirm a message.

type ControlOutcomeType {
acknowledgement: String
audience: String
kind: String!
message: String
permission: String
requireReason: Boolean!
stages: [ControlApprovalStageType!]!
staleWhen: [String!]!
}

Fields​

ControlOutcomeType.acknowledgement ● String scalar​

A confirm control's tick box text. Null for none.

ControlOutcomeType.audience ● String scalar​

A confirm control's audience: staff or customer. Null otherwise.

ControlOutcomeType.kind ● String! non-null scalar​

block, approval or confirm.

ControlOutcomeType.message ● String scalar​

The message shown when a block control refuses, or that a confirm control asks the person to confirm.

ControlOutcomeType.permission ● String scalar​

The permission a person needs to approve, for an approval control.

ControlOutcomeType.requireReason ● Boolean! non-null scalar​

A confirm control asks for a reason. False otherwise.

ControlOutcomeType.stages ● [ControlApprovalStageType!]! non-null object​

An approval control's stages, in order. Empty for one decision and for other outcomes.

ControlOutcomeType.staleWhen ● [String!]! non-null scalar​

Facts whose change after approval makes the approval stale (approval controls only).

Member Of​

ControlPresetType object ● ControlRuleType object