API Reference

The BoM Analytics API 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 will always be equivalent in terms of the functionality being demonstrated.