API reference

The API for Granta MI BoM Analytics is split into these key sections:

• Granta MI connection describes how to connect to Granta MI and, if required, configure any schema customizations in the API client. It also explains how to run queries.

• Log messages describes the structure of log messages returned by the Granta MI server.

• Exceptions lists the possible custom exceptions that might be raised.

• Batching requests explains how queries are batched if they exceed a certain size.

• Impacted substances API explains how to build queries for impacted substances and interpret results.

• Compliance API explains how to build specific queries for compliance and how to interpret results.

Note

While some examples use a different class than the one being documented, both classes are always equivalent in terms of the capability being demonstrated.

• Granta MI connection
  • Connection builder
  • BoM Analytics client
• Log messages
• Exceptions
• Batching requests
  • Very complex part and specification hierarchies
  • Very simple part and specification hierarchies
  • Large numbers of indicators or legislations
• Impacted substances API
  • Part impacted substances
  • Specification impacted substances
  • Material impacted substances
  • BoM impacted substances
  • Impacted substances
• Compliance API
  • Part compliance
  • Specification compliance
  • Material compliance
  • Substance compliance
  • BoM compliance
  • Indicators