Sustainability API

This section provides an overview of the API for sustainability. The BoM sustainability and BoM sustainability summary queries can be used to determine the environmental performance of a BoM (bill of materials) in Ansys Granta MI 2301 XML BoM format.

The BoM analysis only considers items explicitly defined in the input BoM. It does not follow links to other BoM items as in the record-based queries available for Impacted Substances and Compliance analysis.

For more information about BoM item types relevant for sustainability analysis, see BoM item types for Sustainability in the Granta MI product documentation.

Note

The API documented in this section is only available if you have the MI Restricted Substances feature included in your license. A LicensingException will be raised if the feature is not available.

Added in version 2.0.

• BoM sustainability
  • Query definition
    • BomSustainabilityQuery
  • Query result
    • BomSustainabilityQueryResult
  • Transport
    • TransportWithSustainabilityResult
  • Part
    • PartWithSustainabilityResult
  • Material
    • MaterialWithSustainabilityResult
  • Process
    • ProcessWithSustainabilityResult
• BoM sustainability summary
  • Query definition
    • BomSustainabilitySummaryQuery
  • Query result
    • BomSustainabilitySummaryQueryResult
  • Phase summary
    • SustainabilityPhaseSummaryResult
  • Transport
    • TransportSummaryResult
  • Material
    • MaterialSummaryResult
    • ContributingComponentResult
  • Process
    • ProcessSummaryResult
• Common
  • Value with unit
    • ValueWithUnit
  • Record references
    • PartReference
    • MaterialReference
    • ProcessReference
    • TransportReference