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!
  latestGenerationByFileId(
    designGrid: ID!
    fileId: String!
  ): DesignDataGeneration_Preview!
  latestGenerationByUploadId(
    uploadGrid: ID!
  ): DesignDataGeneration_Preview!
  ruleCheckAggregateResultsByDesignId(
    designId: ID!
    revisionId: String
    where: RuleCheckExecution_PreviewFilterInput
  ): RuleCheckAggregateExecution_Preview!
  ruleCheckAggregateResultsByReleaseId(
    designId: ID!
    releaseId: ID!
    where: RuleCheckExecution_PreviewFilterInput
  ): RuleCheckAggregateExecution_Preview!
  ruleCheckById(
    id: ID!
  ): RuleCheck_Preview
  ruleCheckExecution(
    id: ID!
  ): RuleCheckExecution_Preview
  ruleCheckExecutions(
    ids: [ID!]!
  ): [RuleCheckExecution_Preview]!
  ruleCheckExecutionsByDesignId(
    designId: ID!
    revisionId: String
    where: RuleCheckExecution_PreviewFilterInput
  ): [RuleCheckExecution_Preview!]!
  ruleCheckExecutionsByReleaseId(
    designId: ID!
    releaseId: ID!
    where: RuleCheckExecution_PreviewFilterInput
  ): [RuleCheckExecution_Preview!]!
  ruleCheckLatestExecution(
    designId: ID!
    revisionId: String
  ): RuleCheckExecution_Preview!
  ruleCheckLatestExecutionByUploadId(
    uploadId: ID!
  ): RuleCheckExecution_Preview!
  ruleChecksByAuth: [RuleCheck_Preview!]!
  ruleChecksByIds(
    ids: [ID!]!
  ): [RuleCheck_Preview]!
}

Fields​

DesignPreviewQueries.latestGeneration ● DesignDataGeneration_Preview! non-null object​

**Experimental** Retrieves the design data generation

DesignPreviewQueries.latestGeneration.designGrid ● ID! non-null scalar​
DesignPreviewQueries.latestGeneration.revisionId ● String scalar​

The identifier of the project commit.

DesignPreviewQueries.latestGenerationByFileId ● DesignDataGeneration_Preview! non-null object​

**Experimental** Retrieves the design data generation

DesignPreviewQueries.latestGenerationByFileId.designGrid ● ID! non-null scalar​
DesignPreviewQueries.latestGenerationByFileId.fileId ● String! non-null scalar​

DesignPreviewQueries.latestGenerationByUploadId ● DesignDataGeneration_Preview! non-null object​

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

DesignPreviewQueries.latestGenerationByUploadId.uploadGrid ● ID! non-null scalar​

DesignPreviewQueries.ruleCheckAggregateResultsByDesignId ● RuleCheckAggregateExecution_Preview! non-null object​

**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 ● RuleCheckExecution_PreviewFilterInput input​

DesignPreviewQueries.ruleCheckAggregateResultsByReleaseId ● RuleCheckAggregateExecution_Preview! non-null object​

**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 ● RuleCheckExecution_PreviewFilterInput input​

DesignPreviewQueries.ruleCheckById ● RuleCheck_Preview object​

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

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

The ID of the rule check.

DesignPreviewQueries.ruleCheckExecution ● RuleCheckExecution_Preview object​

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

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

The ID of the rule check execution.

DesignPreviewQueries.ruleCheckExecutions ● [RuleCheckExecution_Preview]! non-null object​

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

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

The IDs of the rule check executions.

DesignPreviewQueries.ruleCheckExecutionsByDesignId ● [RuleCheckExecution_Preview!]! non-null object​

**Experimental** Retrieves all rule check executions for a design's revision. Supports HotChocolate 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 scalar​

The identifier of the project commit.

DesignPreviewQueries.ruleCheckExecutionsByDesignId.where ● RuleCheckExecution_PreviewFilterInput input​

DesignPreviewQueries.ruleCheckExecutionsByReleaseId ● [RuleCheckExecution_Preview!]! non-null object​

**Experimental** Retrieves all rule check executions for a design's revision. Supports HotChocolate 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 ● RuleCheckExecution_PreviewFilterInput input​

DesignPreviewQueries.ruleCheckLatestExecution ● RuleCheckExecution_Preview! non-null object​

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

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

The ID of design.

DesignPreviewQueries.ruleCheckLatestExecution.revisionId ● String scalar​

The identifier of the project commit.

DesignPreviewQueries.ruleCheckLatestExecutionByUploadId ● RuleCheckExecution_Preview! non-null object​

**Experimental** Retrieves the latest rule check execution for an upload.

DesignPreviewQueries.ruleCheckLatestExecutionByUploadId.uploadId ● ID! non-null scalar​

The ID of the upload.

DesignPreviewQueries.ruleChecksByAuth ● [RuleCheck_Preview!]! non-null object​

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

DesignPreviewQueries.ruleChecksByIds ● [RuleCheck_Preview]! non-null object​

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

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

The IDs of the rule checks.