SupRefDesign

A reference design model aggregates the relevant documents, files and parts.

Common Data Model

• Reference Design — An example design published in the supply catalog, bringing together its design files (e.g. schematics and layouts), documentation and the parts it uses. In Renesas 365 a reference design can be imported into a solution, which adds it to the Workspace as a PCB project linked to that solution.
  • IRI: https://w3id.org/altium/cdm/supply/ReferenceDesign
  • GRID: grid:supply::platform:ref-design/{id}

Returned By

supRefDesignById query ● supRefDesignByIds query ● supRefDesignByName query ● supRefDesignsByIds query

Member Of

SupEvalKit object ● SupEvalKitDevice object ● SupRefDesign object ● SupRefDesignResultSet object ● SupSolutionTemplate object

Implemented By

SupSolutionTemplateRefDesign union

type SupRefDesign {
  id: ID!
  title: String!
  stableName: String!
  subtitle: String
  description: String!
  type: SupRefDesignType!
  sourceUrl: String
  isVerified: Boolean!
  createdAt: DateTime!
  updatedAt: DateTime!
  hasEvalBoard: Boolean!
  publisherId: String!
  bomId: String
  releaseDate: DateTime
  defaultSchematicFile: String
  status: SupRefDesignStatus
  parts(
    designators: [String!]
    type: SupRefPartType
    types: [SupRefPartType]
    start: Int! = 0
    limit: Int! = 50
  ): [SupRefPart]!
  applicationIds: [String!]!
  evaluationKitIds: [String!]! @deprecated
  previewImages: [SupImage]
  faqs: [SupRefFaq!]!
  keyFeatures: [SupRefKeyFeature]!
  designFiles(
    type: String
    extensions: [String!]
  ): [SupRefDesignFile]!
  documentations: [SupDocument]!
  tags: [SupRefTag]
  softwares: [SupRefResource]!
  evaluationKits: [SupRefEvaluationKit!]
  publisher: [SupCompany!]
  applications: [SupCategory!]
  evalKitDetails(
    where: SupEvalKitByRefDesignFilterInput
    first: Int
    after: String
    last: Int
    before: String
  ): SupEvalKitConnection
  self: SupRefDesign
}

Fields

id ● ID! non-null scalar

The reference design identifier.

title ● String! non-null scalar

The reference design title.

stableName ● String! non-null scalar

The stable name identifier.

subtitle ● String scalar

The subtitle providing context.

description ● String! non-null scalar

The detailed description.

type ● SupRefDesignType! non-null enum

The type identifier of this reference design.

sourceUrl ● String scalar

The source URL where the reference design is published.

isVerified ● Boolean! non-null scalar

Indicates whether the reference design is verified.

createdAt ● DateTime! non-null scalar

The creation date.

updatedAt ● DateTime! non-null scalar

The last updated date.

hasEvalBoard ● Boolean! non-null scalar

Indicates if an evaluation board is available.

publisherId ● String! non-null scalar

The publisher identifier.

bomId ● String scalar

The bill of materials (BOM) identifier.

releaseDate ● DateTime scalar

The release date of the reference design.

defaultSchematicFile ● String scalar

The default schematic file associated with the reference design.

status ● SupRefDesignStatus enum

The status name.

parts ● [SupRefPart]! non-null object

Part identifiers of the reference design, including their designators.

designators ● [String!] list scalar

type ● SupRefPartType deprecated enum

DEPRECATED

Use 'types' instead

types ● [SupRefPartType] list enum

start ● Int! non-null scalar

limit ● Int! non-null scalar

applicationIds ● [String!]! non-null scalar

The list of application identifiers related to the reference design.

previewImages ● [SupImage] list object Supply

Preview images that provide a visual overview of the reference design.

faqs ● [SupRefFaq!]! non-null object

Frequently asked questions about the reference design.

keyFeatures ● [SupRefKeyFeature]! non-null object

Key features highlighting the capabilities of the reference design.

designFiles ● [SupRefDesignFile]! non-null object

Design files, such as schematics and layouts, for the reference design.

type ● String scalar

extensions ● [String!] list scalar

documentations ● [SupDocument]! non-null object Supply

Documentation resources related to the reference design.

tags ● [SupRefTag] list object

Tags categorizing the reference design for search and organization.

softwares ● [SupRefResource]! non-null object

Software packages and resources associated with the reference design.

evaluationKits ● [SupRefEvaluationKit!] list object

The list of evaluation kits associated with the reference design.

publisher ● [SupCompany!] list object Supply

applications ● [SupCategory!] list object Supply

evalKitDetails ● SupEvalKitConnection object Eval Kit

where ● SupEvalKitByRefDesignFilterInput input Eval Kit

first ● Int scalar

Returns the first _n_ elements from the list.

after ● String scalar

Returns the elements in the list that come after the specified cursor.

last ● Int scalar

Returns the last _n_ elements from the list.

before ● String scalar

Returns the elements in the list that come before the specified cursor.

self ● SupRefDesign object

The reference design entity for Nexar schema stitching purposes.

Show deprecated

evaluationKitIds ● [String!]! deprecated non-null scalar

DEPRECATED

Use 'evaluationKits' instead.

The list of evaluation kit identifiers associated with the reference design.