ControlRuleType

A control: one rule checked at one checkpoint, with its mode and recent decisions.

type ControlRuleType {
  archived: Boolean!
  checkpoint: String!
  conditions: [ControlConditionType!]!
  counts: ControlDecisionCountsType!
  id: ID!
  invalid: Boolean!
  invalidReason: String
  join: String!
  lastModeChange: ControlModeChangeType
  mode: String!
  name: String!
  order: Int!
  outcome: ControlOutcomeType!
  presetId: String
  revision: Int!
  scope: ControlScopeType!
  version: Int!
}

Fields

ControlRuleType.archived ● Boolean! non-null scalar

Whether the control is archived.

ControlRuleType.checkpoint ● String! non-null scalar

The checkpoint the control runs at, e.g. order.confirm.

ControlRuleType.conditions ● [ControlConditionType!]! non-null object

The conditions, at most ten, in one level.

ControlRuleType.counts ● ControlDecisionCountsType! non-null object

The control's decisions in the last 30 days.

ControlRuleType.id ● ID! non-null scalar

The ID of the control.

ControlRuleType.invalid ● Boolean! non-null scalar

True when the stored rule no longer passes validation. It is shown, never hidden.

ControlRuleType.invalidReason ● String scalar

Why the stored rule is invalid.

ControlRuleType.join ● String! non-null scalar

all: every condition must match; any: one is enough.

ControlRuleType.lastModeChange ● ControlModeChangeType object

The latest change to the control's mode, from the settings history. Set on the controls list; null elsewhere or when the history has none.

ControlRuleType.mode ● String! non-null scalar

off, observe or enforce.

ControlRuleType.name ● String! non-null scalar

The control's name.

ControlRuleType.order ● Int! non-null scalar

The control's position in the list.

ControlRuleType.outcome ● ControlOutcomeType! non-null object

What happens when the conditions match.

ControlRuleType.presetId ● String scalar

The preset the control was created from, if any.

ControlRuleType.revision ● Int! non-null scalar

Counts every change, including mode changes.

ControlRuleType.scope ● ControlScopeType! non-null object

The customers and warehouses the control covers.

ControlRuleType.version ● Int! non-null scalar

The rule version approvals bind to. It changes only when the rule itself changes.

Returned By

archiveControl mutation ● control query ● controls query ● saveControl mutation ● setControlMode mutation

Member Of

ControlVersionType object