Skip to main content
View as Markdown

Bounded contexts

The reference is grouped by bounded context: a business area with its own entities and vocabulary. Each context lists its queries, mutations and types. A type that is used in one context but defined in another shows the defining context as a badge.

ContextWhat it ownsExample entry points
SupplyParts, offers, sellers, manufacturers, categories, attributes, part search and matchingsupSearch, supSearchMpn, supParts, supMultiMatch
Part FamilyPart families and part groups, their parameters, and searchsupPartFamilySearch, supPartGroupById
Reference DesignReference designs, their files, parts and resourcessupRefDesigns, supRefDesignById
Solution TemplateSolution templates and their applications, parameters, compatible evaluation kits and reference designssupSolutionTemplateSearch, supSolutionTemplateById
Eval KitEvaluation kits, their devices, parameters and preview images, and the reference designs and software projects they are compatible withsupEvalKitSearch, supEvalKitById
Supply Software ProjectSoftware projects and their compatibility with evaluation kits and solution templatessupSoftwareProjectSearch, supSoftwareProjectById
ProcurementBill of materials analysis built on supply datadatBomParts, datBomAnalyses

Common holds the scalars, paging and error types that every context uses.

A single request can combine contexts. This one matches a BOM line to Octopart parts (Procurement) and reads each match from Supply:

query MatchBomLine {
datBomParts(items: [{ itemRefId: "R1", mpn: "RC0603FR-0710KL", manufacturerName: "Yageo" }]) {
itemRefId
parts {
confidence
part {
mpn
manufacturer {
name
}
}
}
}
}

What is not on this site​

The endpoint serves more than these seven contexts. Operations that are not documented here are not part of the Octopart API as described on this site:

  • Design data (des… operations) is documented in the Altium 365 API reference.
  • Other domains served by the same gateway are outside the scope of this reference.

The downloadable schema.graphql contains the documented scope only.


Comments​