Compliance API#
This section provides an overview of the API for compliance. The Substance compliance, Material compliance, Specification compliance, and Part compliance queries (collectively referred to as record-based compliance queries) can be used to determine the compliance of records in a Granta MI database. These queries will also consider any additional associated BoM items stored in Granta MI. For example, if the specified part record contains links to other parts and specifications, these will be included in the analysis.
The BoM compliance query accepts a BoM (bill of materials) in XML format and returns the compliance status of the BoM based on the BoM’s contents. As opposed to record-based queries, the BoM compliance 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 described above.
In both cases, compliance is determined based on a number of Indicators. An indicator is a collection of one or more legislations and a threshold. If a certain record directly or indirectly contains substances impacted by one of the specified legislations in an amount that exceeds the threshold, the record is not compliant with that indicator. For more information about possible results, see the definitions of the indicators.
In general, the result of each query is a recursive BoM (or multi-level BoM) that shows the compliance status and impacted substances at each level. If you are looking for a simple determination of the substances indirectly or directly contained within a item represented by a Granta MI record, consider using the Impacted substances API.
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.