Skip to main content

RuleCheckQueries

**Experimental** The entry point for queries related to design rule checks.

type RuleCheckQueries {
  byAuth: [RuleCheck!]!
  byId(
    id: ID!
  ): RuleCheck
  byIds(
    ids: [ID!]!
  ): [RuleCheck]!
  configuration: RuleCheckConfiguration!
}

Fields​

RuleCheckQueries.byAuth ● [RuleCheck!]! non-null object​

**Experimental** Retrieves all rule checks contained in the workspace.

RuleCheckQueries.byId ● RuleCheck object​

**Experimental** Retrieves a rule check by its identifier.

RuleCheckQueries.byId.id ● ID! non-null scalar​

The identifier of the rule check.

RuleCheckQueries.byIds ● [RuleCheck]! non-null object​

**Experimental** Retrieves rule checks by their identifiers.

RuleCheckQueries.byIds.ids ● [ID!]! non-null scalar​

The identifiers of the rule checks.

RuleCheckQueries.configuration ● RuleCheckConfiguration! non-null object​

**Experimental** Retrieves current rule check configuration.