Skip to main content

DesignPreviewQueries

**Experimental** Entry point for the experimental design preview queries, which may change or be removed without deprecation.

type DesignPreviewQueries {
latestGeneration(
designGrid: ID!
revisionId: String
): DesignDataGeneration_Preview @deprecated
latestGenerationByUploadId(
uploadId: String!
): DesignDataGeneration_Preview @deprecated
ruleCheckAggregateResultsByDesignId(
designId: ID!
revisionId: String
where: RuleCheckExecutionFilterInput
): RuleCheckAggregateExecution_Preview @deprecated
ruleCheckAggregateResultsByReleaseId(
designId: ID!
releaseId: ID!
where: RuleCheckExecutionFilterInput
): RuleCheckAggregateExecution_Preview @deprecated
ruleCheckById(
id: ID!
): RuleCheck @deprecated
ruleCheckConfiguration: RuleCheckConfiguration! @deprecated
ruleCheckExecution(
id: ID!
): RuleCheckExecution_Preview @deprecated
ruleCheckExecutions(
ids: [ID!]!
): [RuleCheckExecution_Preview] @deprecated
ruleCheckExecutionsByDesignId(
designId: ID!
revisionId: String!
where: RuleCheckExecutionFilterInput
): [RuleCheckExecution_Preview!] @deprecated
ruleCheckExecutionsByReleaseId(
designId: ID!
releaseId: ID!
where: RuleCheckExecutionFilterInput
): [RuleCheckExecution_Preview!] @deprecated
ruleCheckLatestExecution(
designId: ID!
revisionId: String
): RuleCheckExecution_Preview @deprecated
ruleChecksByAuth: [RuleCheck!]! @deprecated
ruleChecksByIds(
ids: [ID!]!
): [RuleCheck]! @deprecated
}

Fields

DesignPreviewQueries.latestGeneration ● DesignDataGeneration_Preview deprecated object

DEPRECATED

Use design.latestGeneration.byDesignId instead.

**Experimental** Retrieves the design data generation.

DesignPreviewQueries.latestGeneration.designGrid ● ID! non-null scalar

The identifier of the design.

DesignPreviewQueries.latestGeneration.revisionId ● String scalar

The identifier of the project commit.

DesignPreviewQueries.latestGenerationByUploadId ● DesignDataGeneration_Preview deprecated object

DEPRECATED

Use design.latestGeneration.byUploadId instead.

**Experimental** Retrieves the design data generation for the upload.

DesignPreviewQueries.latestGenerationByUploadId.uploadId ● String! non-null scalar

The identifier of the upload.

DesignPreviewQueries.ruleCheckAggregateResultsByDesignId ● RuleCheckAggregateExecution_Preview deprecated object

DEPRECATED

Use design.ruleCheckExecution.byDesignIdAggregated instead.

**Experimental** Retrieves the aggregated rule check results for a design.

DesignPreviewQueries.ruleCheckAggregateResultsByDesignId.designId ● ID! non-null scalar

The identifier of the design.

DesignPreviewQueries.ruleCheckAggregateResultsByDesignId.revisionId ● String scalar

The identifier of the project commit.

DesignPreviewQueries.ruleCheckAggregateResultsByDesignId.where ● RuleCheckExecutionFilterInput input

DesignPreviewQueries.ruleCheckAggregateResultsByReleaseId ● RuleCheckAggregateExecution_Preview deprecated object

DEPRECATED

Use design.ruleCheckExecution.byReleaseIdAggregated instead.

**Experimental** Retrieves the aggregated rule check results for a design.

DesignPreviewQueries.ruleCheckAggregateResultsByReleaseId.designId ● ID! non-null scalar

The identifier of the design.

DesignPreviewQueries.ruleCheckAggregateResultsByReleaseId.releaseId ● ID! non-null scalar

The identifier of the project release.

DesignPreviewQueries.ruleCheckAggregateResultsByReleaseId.where ● RuleCheckExecutionFilterInput input

DesignPreviewQueries.ruleCheckById ● RuleCheck deprecated object

DEPRECATED

Use design.ruleCheck.byId instead.

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

DesignPreviewQueries.ruleCheckById.id ● ID! non-null scalar

The identifier of the rule check.

DesignPreviewQueries.ruleCheckConfiguration ● RuleCheckConfiguration! deprecated non-null object

DEPRECATED

Use design.ruleCheck.configuration instead.

**Experimental** Retrieves current rule check configuration.

DesignPreviewQueries.ruleCheckExecution ● RuleCheckExecution_Preview deprecated object

DEPRECATED

Use design.ruleCheckExecution.byId instead.

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

DesignPreviewQueries.ruleCheckExecution.id ● ID! non-null scalar

The identifier of the rule check execution.

DesignPreviewQueries.ruleCheckExecutions ● [RuleCheckExecution_Preview] deprecated list object

DEPRECATED

Use design.ruleCheckExecution.byIds instead.

**Experimental** Retrieves multiple rule check executions by their identifiers.

DesignPreviewQueries.ruleCheckExecutions.ids ● [ID!]! non-null scalar

The identifiers of the rule check executions.

DesignPreviewQueries.ruleCheckExecutionsByDesignId ● [RuleCheckExecution_Preview!] deprecated list object

DEPRECATED

Use design.ruleCheckExecution.byDesignId instead.

**Experimental** Retrieves all rule check executions for a design's revision. Supports filtering on reason and source via the standard 'where' argument.

DesignPreviewQueries.ruleCheckExecutionsByDesignId.designId ● ID! non-null scalar

The identifier of the design.

DesignPreviewQueries.ruleCheckExecutionsByDesignId.revisionId ● String! non-null scalar

The identifier of the project commit.

DesignPreviewQueries.ruleCheckExecutionsByDesignId.where ● RuleCheckExecutionFilterInput input

DesignPreviewQueries.ruleCheckExecutionsByReleaseId ● [RuleCheckExecution_Preview!] deprecated list object

DEPRECATED

Use design.ruleCheckExecution.byReleaseId instead.

**Experimental** Retrieves all rule check executions for a design's revision. Supports filtering on reason and source via the standard 'where' argument.

DesignPreviewQueries.ruleCheckExecutionsByReleaseId.designId ● ID! non-null scalar

The identifier of the design.

DesignPreviewQueries.ruleCheckExecutionsByReleaseId.releaseId ● ID! non-null scalar

The identifier of the release.

DesignPreviewQueries.ruleCheckExecutionsByReleaseId.where ● RuleCheckExecutionFilterInput input

DesignPreviewQueries.ruleCheckLatestExecution ● RuleCheckExecution_Preview deprecated object

DEPRECATED

Use design.ruleCheckExecution.byDesignIdAggregated instead.

**Experimental** Retrieves the latest rule check execution for a WIP design.

DesignPreviewQueries.ruleCheckLatestExecution.designId ● ID! non-null scalar

The identifier of the design.

DesignPreviewQueries.ruleCheckLatestExecution.revisionId ● String scalar

The identifier of the project commit.

DesignPreviewQueries.ruleChecksByAuth ● [RuleCheck!]! deprecated non-null object

DEPRECATED

Use design.ruleCheck.byAuth instead.

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

DesignPreviewQueries.ruleChecksByIds ● [RuleCheck]! deprecated non-null object

DEPRECATED

Use design.ruleCheck.byIds instead.

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

DesignPreviewQueries.ruleChecksByIds.ids ● [ID!]! non-null scalar

The identifiers of the rule checks.