SupPartGroup
SupPartGroup contains the relevant information relating to a part group.
It represents the leaves of the Part Family hierarchy, and contain the parts represented by this group.
Common Data Model
- Part Group — A leaf of the part family hierarchy in the supply data, holding the parts that belong to it together with group-level information such as its manufacturer, overview, key features and documents. Groups sharing the same parent family are usually close alternatives to one another.
- IRI:
https://w3id.org/altium/cdm/supply/PartGroup - GRID:
grid:supply::platform:part-group/{id}
- IRI:
Returned By
supPartGroupById query ● supPartGroupByName query ● supPartGroupByPartId query ● supPartGroupsByIds query
Member Of
SupPartFamily object ● SupPartGroup object
Interfaces
SupPartFamilyEntity interface
Shared Fields between SupPartFamily and SupPartGroup.
Implemented By
SupPartFamilyPartSearchResult union ● SupPartFamilySearchResult union
type SupPartGroup implements SupPartFamilyEntity {
id: ID!
stableName: String!
parent: SupPartFamily
siblings: [SupPartGroup!]!
title: String!
subtitle: String!
overview: String!
categoryID: String!
applicationIDs: [String!]!
tags: [SupPartFamilyTag!]!
lifecycleStatus: SupPartFamilyLifecycleStatus!
keyFeatures: [SupPartFamilyKeyFeature!]!
manufacturerID: String!
partIDs(
start: Int! = 0
limit: Int! = 10
): [String!]!
price(
country: String! = US
currency: String! = USD
quantity: Int! = 1000
): SupPartFamilyPrice
complementaryParts: [SupPartFamilyComplementaryPart!]!
referenceDesignIDs: [String!]!
documents(
type: SupPartFamilyDocumentType
): [SupPartFamilyDocument!]!
softwareSupport: [SupPartFamilySoftwareSupport!]!
videos: [SupPartFamilyVideo!]!
category: SupCategory!
applications: [SupCategory]!
manufacturer: [SupCompany!]
parts: [SupPart]!
}
Fields
id ● ID! non-null scalar
id is the global resource id (GRID) for this Part Group.
stableName ● String! non-null scalar
stableName is an immutable name of this part family.
parent ● SupPartFamily object
parent is the the part family representing the direct parent of this group.
siblings ● [SupPartGroup!]! non-null object
siblings is a list of direct sibling part groups of the current group, which have the same parent.
They are usually a close alternative choice of the current group.
title ● String! non-null scalar
title of the part group.
subtitle ● String! non-null scalar
subtitle of the part group.
overview ● String! non-null scalar
overview of the key details of this part group.
categoryID ● String! non-null scalar
categoryID is the identifier of the part category of this part group.
applicationIDs ● [String!]! non-null scalar
applicationIDs is a list of the identifiers of relevant applications this part group can be useful for.
tags ● [SupPartFamilyTag!]! non-null object
tags is a list of additional metadata for categorizing this part group.
lifecycleStatus ● SupPartFamilyLifecycleStatus! non-null enum
lifecycleStatus is an enum representing the normalized lifecycle status of this part group.
keyFeatures ● [SupPartFamilyKeyFeature!]! non-null object
keyFeatures is the list of key part features relevant to this part group.
manufacturerID ● String! non-null scalar
manufacturerID is the identifier of the manufacturer of this part group.
partIDs ● [String!]! non-null scalar
partIDs is the list of identifiers of the physical parts within this group.
start and limit are used for paging part results (including those under the parts field).
limit has a max value of 20, any value greater than this will be reduced to it.
start ● Int! non-null scalar
limit ● Int! non-null scalar
price ● SupPartFamilyPrice object
price contains pricing information for this part group.
It contains the minimum, maximum, and median unit price @ given quantity among all parts in the group.
country ● String! non-null scalar
currency ● String! non-null scalar
quantity ● Int! non-null scalar
complementaryParts ● [SupPartFamilyComplementaryPart!]! non-null object
complementaryParts is a list of the identifiers of relevant parts which work with this group.
referenceDesignIDs ● [String!]! non-null scalar
referenceDesignIDs is a list of the identifiers of reference designs relevant to this part group.
documents ● [SupPartFamilyDocument!]! non-null object
documents is a list of the key documentation related to this part group.
type ● SupPartFamilyDocumentType enum
softwareSupport ● [SupPartFamilySoftwareSupport!]! non-null object
softwareSupport is a list of the key supporting documents for this part group.
videos ● [SupPartFamilyVideo!]! non-null object
videos is a list of key videos related to this part group.