Skip to main content

DesignRuleCheckExecuteInput

**Experimental** Represents the input for executing rule checks on a design.

input DesignRuleCheckExecuteInput {
  clientExecutionId: String
  configuration: DesignRuleCheckExecutionConfigurationInput
  designId: ID!
  reason: String!
  revisionId: String
  source: String!
}

Fields​

DesignRuleCheckExecuteInput.clientExecutionId ● String scalar​

**Experimental** Client-generated identifier used together with the design and revision to deduplicate executions.

DesignRuleCheckExecuteInput.configuration ● DesignRuleCheckExecutionConfigurationInput input​

**Experimental** Custom configuration of the rule check reporting. When specified, overrides the configuration stored in the design data for this execution only.

DesignRuleCheckExecuteInput.designId ● ID! non-null scalar​

**Experimental** The identifier of the design to execute rule checks for.

DesignRuleCheckExecuteInput.reason ● String! non-null scalar​

**Experimental** Reason why the rule check execution is triggered, which can be used for filtering and distinguishing different types of rule check executions. Known values: CHANGE, PROCESS, REGENERATION, RELEASE_CANDIDATE, RELEASE, UPLOAD. New values may be added; clients must tolerate unknown values.

DesignRuleCheckExecuteInput.revisionId ● String scalar​

**Experimental** The identifier of the project commit. If not specified, the latest commit is used.

DesignRuleCheckExecuteInput.source ● String! non-null scalar​

**Experimental** Source of the rule check execution, identifying whether it is triggered by a user or by the system. Known values: SYSTEM, USER. New values may be added; clients must tolerate unknown values.