API documentation - ECODB
Koen de Beer avatar
Written by Koen de Beer
Updated over a week ago

EcoDB

EcoDB

EcoDB entities objects that are used for product data mapping

ENDPOINTS:
GET /ecodb/list

EcoDB Objects


Entity Object

· _id string*
Unique identifier for the object.

· ecoDbId string*
External identifier used to map to product values.

· displayName string*
External entity name that is assigned to product when specific entity is selected.

· displayNameIdematCategory string
External category name used for material entity type grouping.

· value number*
Base ratio used for ecoScore calculations based on selected unit. Usually equals 1 .

· unit enum* ["kg", "m3", "kWh", "tkm", "m3km", "GJ"]
Entity unit type used for ecoScore calculations.

· type enum* ["material", "production", "transport", "eol", "electricityProduction"]
Entity type.
Material: product material
Production: product production method
Transport: product transport method
EOL: product end of life method
ElectricityProduction: product location

· defaultEol string
For material type only. Default EOL method for specified material

· tags string[]
Comma separated tags used for entity grouping or search

· sourceDisplayName string
Info data source text for specific entity.

· sourceLink string
Data source link for specific entity.


Material Component Object

· _id string*
Unique identifier for the object.

· ecoDbId string*
External identifier used to map to product values.

· value number*
Material share that is used when specific material component is selected

· displayName string*
External entity name that is assigned to product material component when specific material component is selected.


Product Category Object

· _id string*
Unique identifier for the object.

· ecoDbId string*
External identifier used to map to product values.

· displayOrder number*
Internal order for product category

· displayName string*
External category name that is assigned to product category when specific category is selected.


Product Industry Object

· _id string*
Unique identifier for the object.

· ecoDbId string*
External identifier used to map to product values.

· displayOrder number*
Internal order for product category

· displayName string*
External category name that is assigned to product category when specific category is selected.


Transport Category Object

· _id string*
Unique identifier for the object.

· ecoDbId string*
External identifier used to map to product values.

· displayName string*
External category name that is assigned to transport category when specific category is selected.

· sourceDisplayName string
Info data source text for specific entity.

· sourceLink string
Data source link for specific entity.


Default Production Method Object

· _id string*
Unique identifier for the object.

· ecoDbId string*
External identifier used to map to product values.

· productionMethodEcoDbId string[]*
External ecoDbId linking to Entity Object of type production.

· productCategory string[]*
External product category name linking to Product Category Object displayName

· productComponent string[]*
External material component name linking to Material Component Object displayName

· materialIdematCategory string[]*
External material IdematCategory name linking to Entity Object of type material idematCategory

ECODB ENTITY OBJECT:
{
"_id": "63774dc60931ea2da7696caf",
"ecoDbId": "A.010.06.102",
"displayName": "bio-Cotton (India)",
"displayNameIdematCategory": "Fabric",
"value": 1,
"unit": "kg",
"type": "material",
"defaultEol": "F.080.01.108",
"tags": ["Deccan-hennep", "Java-jute"],
"sourceDisplayName": "Source Display Name",
"sourceLink": "https://example.com"
}
ECODB MATERIAL COMPONENT OBJECT:
{
"_id":"6387756507140503bedfa49c",
"ecoDbId":"PP.001",
"displayName":"Main component",
"value":100
}
ECODB PRODUCT CATEGORY OBJECT:
{
"_id":"6387755107140503bedfa3c2",
"ecoDbId":"PC.001",
"displayOrder": 1,
"displayName":"Beverage packaging"
}
ECODB PRODUCT INDUSTRY OBJECT:
{
"_id":"6387755107140503bedfa3c2",
"ecoDbId":"PI.001",
"displayOrder": 1,
"displayName":"Fashion"
}
ECODB TRANSPORT CATEGORY OBJECT:
{
"_id":"6387756e07140503bedfa4aa",
"ecoDbId":"TCAT.001",
"displayName":"Plane continental",
"sourceDisplayName": "Source Display Name",
"sourceLink": "https://example.com"
}
ECODB DEFAULT PRODUCTION METHOD OBJECT:
{
"_id":"6387755b07140503bedfa497",
"ecoDbId":"PM.001",
"productionMethodEcoDbId":"D.110.01.101",
"productCategory":[
"Corrugated boxes",
"Folding boxes",
"Food boxes",
"Gift boxes",
"Boxes",
"Tubes"
],
"productComponent":[
"Main component"
],
"materialIdematCategory":[
"Paper"
]
}

Get EcoDB List

Get EcoDB objects list grouped by type.

· ecoDbEntities object[]*
Array of Entity Object

· ecoDbMaterialComponents object[]*
Array of Material Component Object

· ecoDbProductCategories object[]*
Array of Product Category Object

· ecoDbTransportCategories object[]*
Array of Transport Category Object

· ecoDbDefaultProductionMethods object[]*
Array of Default Production Method Object

REQUEST: GET /ecodb/list:

RESPONSE:
{
"ecoDbEntities":[],
"ecoDbMaterialComponents":[],
"ecoDbProductCategories":[],
"ecoDbTransportCategories":[],
"ecoDbDefaultProductionMethods":[]
}
Did this answer your question?