Skip to main content
View as Markdown

DesignRuleCheckExecuteInput

EXPERIMENTAL

Experimental​

caution

Not production-ready. It may change or be removed without notice. See Lifecycle.

Represents the input for executing rule checks on a design.

Member Of​

designRuleCheckExecute mutation

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

Fields​

clientExecutionId ● String scalar​

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

configuration ● DesignRuleCheckExecutionConfigurationInput input​

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

designId ● ID! non-null scalar​

The identifier of the design to execute rule checks for.

reason ● String! non-null scalar​

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.

revisionId ● String scalar​

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

source ● String! non-null scalar​

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.

Show deprecated

idempotencyToken ● String deprecated scalar​

DEPRECATED

idempotencyToken is obsolete. Use clientExecutionId instead.

Idempotency token used together with the design and revision to deduplicate executions.