Skip to main content
View as Markdown

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.

Returned By​

supRefDesignById query ● supRefDesignByIds query ● supRefDesignByName query ● supRefDesignsByIds query

Member Of​

SupEvalKit object ● SupEvalKitDevice object ● SupRefDesignResultSet object ● SupSolutionTemplate object

Implemented By​

SupSolutionTemplateRefDesign union

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

Fields​

applicationIds ● [String!]! non-null scalar​

The list of application identifiers related to the reference design.

bomId ● String scalar​

The bill of materials (BOM) identifier.

createdAt ● DateTime! non-null scalar​

The creation date.

defaultSchematicFile ● String scalar​

The default schematic file associated with the reference design.

description ● String! non-null scalar​

The detailed description.

designFiles ● [SupRefDesignFile]! non-null object​

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

extensions ● [String!] list scalar​
type ● String scalar​

documentations ● [SupDocument]! non-null object​

Documentation resources related to the reference design.

evalKitDetails ● SupEvalKitConnection object​

The evaluation kits of reference design.

after ● String scalar​

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

before ● String scalar​

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

first ● Int scalar​

Returns the first _n_ elements from the list.

last ● Int scalar​

Returns the last _n_ elements from the list.

where ● SupEvalKitByRefDesignFilterInput input​

evaluationKits ● [SupRefEvaluationKit!] list object​

The list of evaluation kits associated with the reference design.

faqs ● [SupRefFaq!]! non-null object​

Frequently asked questions about the reference design.

hasEvalBoard ● Boolean! non-null scalar​

Indicates if an evaluation board is available.

id ● ID! non-null scalar​

The evaluation kit identifier.

isVerified ● Boolean! non-null scalar​

Indicates whether the reference design is verified.

keyFeatures ● [SupRefKeyFeature]! non-null object​

Key features highlighting the capabilities of the reference design.

parts ● [SupRefPart]! non-null object​

Part identifiers of the reference design, including their designators.

designators ● [String!] list scalar​
limit ● Int! non-null scalar​
start ● Int! non-null scalar​
type ● SupRefPartType deprecated enum​
DEPRECATED

Use 'types' instead

types ● [SupRefPartType] list enum​

previewImages ● [SupImage] list object​

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

publisherId ● String! non-null scalar​

The publisher identifier.

releaseDate ● DateTime scalar​

The release date of the reference design.

softwares ● [SupRefResource]! non-null object​

Software packages and resources associated with the reference design.

sourceUrl ● String scalar​

The source URL where the reference design is published.

stableName ● String! non-null scalar​

The stable name identifier.

status ● SupRefDesignStatus enum​

The status name.

subtitle ● String scalar​

The subtitle providing context.

tags ● [SupRefTag] list object​

Tags categorizing the reference design for search and organization.

title ● String! non-null scalar​

The reference design title.

type ● SupRefDesignType! non-null enum​

The type identifier of this reference design.

updatedAt ● DateTime! non-null scalar​

The last updated date.

Show deprecated

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

DEPRECATED

Use 'evaluationKits' instead.

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