Eco-footprint Integration

Eco-footprint can be integrated to other systems by using pre-defined REST API's

This document describes the API's that have specifically been developed to support integration to IFS Eco-footprint but also some of the Standard Entity API's that could commonly be used for interfacing external systems.
Not that more Standard Entity API's exist within the Eco-footprint component, which could be used for integration purposes. For more information and details, refer to the API Explorer.

Following are described in this document:

Eco-footprint Integration API's

API Projection Description
GetNonConformingParts EcomanReporting Service Return a list (JSON format) of non-conforming parts.
CreateOrModifySubstance EcoSubstanceService This API creates new records for substance data. This data is stored in three different entities and the API distributes the input data accordingly. If the substance ID already exists, the records are instead updated. The input is given as an array meaning that multiple records can be created in one call.
DeleteSubstance EcoSubstanceService This API deletes an existing substance ID with all its data in all entities. Existing business logic is used so that data in use can't be deleted.
GetSubstanceInfo EcoSubstanceService Returns all data for a given Substance ID. If no Substance Id is passed, all registered substances are returned.
EcomanRequirementEntity EcomanRequirementEntity Methods
Get: Returns data for a given eco-footprint requirement. If no Requirement ID and Revision are passed, all registered Requirements are returned.
Post: Creates a new Requirement ID and Revision.
Patch: Updates an existing Requirement/Revision combination. Existing business logic is used for validation.
Del: Deletes an existing Requirement/Revision combination. Existing business logic is used for validation. Also an Etag must be provided as If-match parameter to make sure that the latest version is deleted. This Etag can be retrieved by using the Get call.
EcomanRegulatedSubstEntity EcomanRegulatedSubstEntity Methods
Get: Returns substance data for a given eco-footprint requirement/revision. If no Requirement ID and Revision are passed, all regulated substance records are returned.
Post: Creates a new regulated substance record for a requirement revision.
Patch: Updates an existing regulated substance record for a requirement revision. Existing business logic is used for validation.
Del: Deletes an existing regulated substance record. Existing business logic is used for validation. Also an Etag must be provided as If-match parameter to make sure the latest version is deleted. This Etag can be retrieved by using the Get call.

GetNonConformingParts API

This API will return non-conforming parts, i.e. parts with a substance that does not meet the thresholds of the requirement. The data extract is based on output data from the requirement analyses in eco-footprint.

Depending on the input parameters the API will return a list of all non-conforming parts, including; substance, emissions, eco-footprint part information, linked part (parent part), top part and sub records with the full product structure path up to the top part. The subrecords (ProductPath) contain part basic data, parent part and structure level for each part.

Input parameters are:

Mandatory

Optional

Picture 1 - Part Structure

Non-conforming parts in Picture 1 are parts with non-conforming substances marked in red. As an example the extract will then contain the following five records:

Record Part Level Substance Linked Part Top Part Path Subrecords
1 COM-B-L3 3 Substance 1 COM-A-L2 MF Part No Product Part Level
            COM-A-L2 2
            COM-A-L1 1
            MF 0
2 COM-B-L3 3 Substance 2 COM-A-L2 MF Part No Product Part Level
            COM-A-L2 2
            COM-A-L1 1
            MF 0
3 COM-A-L2 2 Substance 3 COM-A-L1 MF Part No Product Part Level
            COM-A-L1 1
            MF 0
4 COM-B-L2 2 Substance 2 COM-A-L1 MF Part No Product Part Level
            COM-A-L1 1
            MF 0
5 COM-B-L1 1 Substance 4 MF MF  

Table 1 - Records of extract

 

CreateOrModifySubstance

Input parameters are sent in an array format. For more information about data mapping etc., refer to the API Explorer.

Mandatory

DeleteSubstance

Substance to delete is passed as a parameter in the URL, refer to the API Explorer for details.

Mandatory

GetSubstanceInfo

Substance to fetch is passed as a parameter in the URL. For more information about data mapping etc., refer to the API Explorer.

Mandatory

EcomanRequirementEntity|Get

Requirement to fetch is passed as parameters in the URL. For more information about data mapping etc., refer to the API Explorer for details.
Filtering on other attributes is also possible if no keys are passed.

Mandatory

EcomanRequirementEntity|Post

Requirement to create is passed as a json array. For more information about data mapping etc., refer to the API Explorer.

Mandatory

EcomanRequirementEntity|Patch

Keys for the record to update are passed in the URL. Other data is sent as a json array. For more information about data mapping etc., refer to the API Explorer.

Mandatory

EcomanRequirementEntity|Del

Keys for the record to delete are passed in the URL, refer to the API Explorer for details.

Mandatory

EcomanRegulatedSubstEntity|Get

Regulated substance data to fetch is passed as parameters in the URL. For more information about data mapping etc., refer to the API Explorer.
Filtering on other attributes is also possible if no keys are passed

Mandatory

EcomanRegulatedSubstEntity|Post

Keys for the record to create are passed in the URL. Additional data passed as a JSON array. For more information about data mapping etc., refer to the API Explorer.

Mandatory

EcomanRegulatedSubstEntity|Patch

Keys for the record to update are passed in the URL. Additional data passed as a JSON array. For more information about data mapping etc., refer to the API Explorer.

Mandatory

EcomanRegulatedSubstEntity|Del

Keys for the record to delete are passed in the URL. For more information, refer to the API Explorer.

Mandatory