Skip to main content

RuleCheckExecution_Preview

**Experimental** Represents the execution of rule checks against a design.

type RuleCheckExecution_Preview {
  designId: ID!
  finishedAt: DateTime
  id: ID!
  reason: RuleCheckExecutionReason_Preview!
  revisionId: String!
  ruleChecks: [RuleCheckPastDefinition_Preview!]!
  source: RuleCheckExecutionSource_Preview!
  startedAt: DateTime!
  startedByUserId: String!
  status: RuleCheckExecutionStatus_Preview!
  violations: [RuleViolation_Preview!]!
}

Fields​

RuleCheckExecution_Preview.designId ● ID! non-null scalar​

**Experimental** The identifier of the design being checked.

RuleCheckExecution_Preview.finishedAt ● DateTime scalar​

**Experimental** The time when the execution finished, if finished.

RuleCheckExecution_Preview.id ● ID! non-null scalar​

**Experimental** The unique identifier of the rule check execution.

RuleCheckExecution_Preview.reason ● RuleCheckExecutionReason_Preview! non-null enum​

**Experimental** Reason why the rule check execution was triggered, which can be used for filtering and distinguishing different types of rule check executions.

RuleCheckExecution_Preview.revisionId ● String! non-null scalar​

**Experimental** The design revision identifier associated with the execution.

RuleCheckExecution_Preview.ruleChecks ● [RuleCheckPastDefinition_Preview!]! non-null object​

**Experimental** The list of rule checks executed as part of this execution, with their definition at the time of execution.

RuleCheckExecution_Preview.source ● RuleCheckExecutionSource_Preview! non-null enum​

**Experimental** Source of the rule check execution, identifying whether it was triggered by a user or by the system.

RuleCheckExecution_Preview.startedAt ● DateTime! non-null scalar​

**Experimental** The time when the execution started.

RuleCheckExecution_Preview.startedByUserId ● String! non-null scalar​

**Experimental** The identifier of the user who started the execution.

RuleCheckExecution_Preview.status ● RuleCheckExecutionStatus_Preview! non-null enum​

**Experimental** The current status of the rule check execution.

RuleCheckExecution_Preview.violations ● [RuleViolation_Preview!]! non-null object​

**Experimental** The list of violations found during execution.