Generated API Reference

This page is generated at build time from www/generated/openapi.json, which is produced by volca dump-openapi.

Use this page for exhaustive endpoint parameters, request bodies, response schemas, and component schemas. For how to use the API, authentication, and common patterns, start with the HTTP API guide.

Overview

• OpenAPI version: 3.0.0
• Operations: 73
• Schemas: 82
• Live server Swagger UI: /api/v1/docs
• Live server OpenAPI JSON: /api/v1/openapi.json

Operations

Method	Path	Operation ID	Summary
GET	/api/v1/db/{dbName}/activity/{processId}	get_activity	LCA / ACV — get detailed information about an activity: name, location, exchanges, reference product, metadata.
GET	/api/v1/db/{dbName}/activity/{processId}/flows	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/inputs	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/outputs	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/reference-product	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/tree	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/inventory	get_inventory	LCA / ACV — compute the Life Cycle Inventory (LCI): biosphere flows (emissions and resource extractions) for an activity's full supply chain.
POST	/api/v1/db/{dbName}/activity/{processId}/inventory	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/graph	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/supply-chain	get_supply_chain	LCA / ACV — get a flat list of all upstream activities in the supply chain (chaîne amont, filière, intrants).
POST	/api/v1/db/{dbName}/activity/{processId}/supply-chain	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/aggregate	aggregate	LCA / ACV — aggregate exchanges, supply chain entries, or biosphere flows with SQL group-by-style filters.
GET	/api/v1/db/{dbName}/activity/{processId}/impacts/{collection}	—	—
POST	/api/v1/db/{dbName}/activity/{processId}/impacts/{collection}	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/impacts/{collection}/{methodId}	get_impacts	LCA / ACV — compute Life Cycle Impact Assessment (LCIA) scores for an activity.
POST	/api/v1/db/{dbName}/activity/{processId}/impacts/{collection}/{methodId}	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/consumers	get_consumers	LCA / ACV — find all activities that transitively consume (depend on) a given supplier.
GET	/api/v1/db/{dbName}/activity/{processId}/path-to	get_path_to	LCA / ACV — find the shortest supply chain path from a process to the first upstream activity whose name matches a pattern.
GET	/api/v1/db/{dbName}/activity/{processId}/analyze/{analyzerName}	—	—
GET	/api/v1/db/{dbName}/activity/{processId}/contributing-flows/{collection}/{methodId}	get_contributing_flows	LCA / ACV — identify which elementary flows (emissions/resources) contribute most to a specific impact category.
GET	/api/v1/db/{dbName}/activity/{processId}/contributing-activities/{collection}/{methodId}	get_contributing_activities	LCA / ACV — identify which upstream activities contribute most to a specific impact category.
GET	/api/v1/db/{dbName}/flow/{flowId}	—	—
GET	/api/v1/db/{dbName}/flow/{flowId}/activities	—	—
GET	/api/v1/methods	list_methods	LCA / ACV — list all loaded LCIA methods (impact assessment methods like climate change, acidification, eutrophication, land use, water scarcity)..
GET	/api/v1/method/{methodId}	—	—
GET	/api/v1/method/{methodId}/factors	—	—
GET	/api/v1/db/{dbName}/method/{methodId}/mapping	—	—
GET	/api/v1/db/{dbName}/method/{methodId}/flow-mapping	get_flow_mapping	LCA / ACV — get the mapping between a method's characterization factors and database flows, showing match coverage..
GET	/api/v1/db/{dbName}/method/{methodId}/characterization	get_characterization	LCA / ACV — look up characterization factors for a method matched against database flows.
GET	/api/v1/db/{dbName}/flows	search_flows	LCA / ACV — search for biosphere flows (emissions, resources) by name.
GET	/api/v1/db/{dbName}/activities	search_activities	LCA / ACV — search for activities (processes) by name, geography, product, classification, or preset.
GET	/api/v1/db/{dbName}/classifications	list_classifications	LCA / ACV — list classification systems in a database.
POST	/api/v1/db/{dbName}/impacts/{collection}	—	—
GET	/api/v1/db	list_databases	LCA / ACV — list all loaded LCA databases (Agribalyse, ecoinvent, …).
POST	/api/v1/db/{dbName}/load	—	—
POST	/api/v1/db/{dbName}/unload	—	—
POST	/api/v1/db/{dbName}/relink	—	—
DELETE	/api/v1/db/{dbName}	—	—
POST	/api/v1/db/upload	—	—
GET	/api/v1/db/{dbName}/setup	—	—
POST	/api/v1/db/{dbName}/add-dependency/{depName}	—	—
POST	/api/v1/db/{dbName}/remove-dependency/{depName}	—	—
POST	/api/v1/db/{dbName}/set-data-path	—	—
POST	/api/v1/db/{dbName}/finalize	—	—
GET	/api/v1/method-collections	—	—
POST	/api/v1/method-collections/{name}/load	—	—
POST	/api/v1/method-collections/{name}/unload	—	—
DELETE	/api/v1/method-collections/{name}	—	—
POST	/api/v1/method-collections/upload	—	—
GET	/api/v1/flow-synonyms	—	—
POST	/api/v1/flow-synonyms/{name}/load	—	—
POST	/api/v1/flow-synonyms/{name}/unload	—	—
DELETE	/api/v1/flow-synonyms/{name}	—	—
POST	/api/v1/flow-synonyms/upload	—	—
GET	/api/v1/flow-synonyms/{name}/groups	—	—
GET	/api/v1/flow-synonyms/{name}/download	—	—
GET	/api/v1/compartment-mappings	—	—
POST	/api/v1/compartment-mappings/{name}/load	—	—
POST	/api/v1/compartment-mappings/{name}/unload	—	—
DELETE	/api/v1/compartment-mappings/{name}	—	—
POST	/api/v1/compartment-mappings/upload	—	—
GET	/api/v1/units	—	—
POST	/api/v1/units/{name}/load	—	—
POST	/api/v1/units/{name}/unload	—	—
DELETE	/api/v1/units/{name}	—	—
POST	/api/v1/units/upload	—	—
GET	/api/v1/logs	—	—
POST	/api/v1/auth	—	—
GET	/api/v1/version	—	—
GET	/api/v1/hosting	—	—
GET	/api/v1/stats	—	—
GET	/api/v1/classification-presets	list_presets	LCA / ACV — list named classification filter presets configured in this instance.
GET	/api/v1/openapi.json	—	—

Operation details

GET /api/v1/db/{dbName}/activity/{processId}

Operation ID: get_activity

Summary: LCA / ACV — get detailed information about an activity: name, location, exchanges, reference product, metadata.

LCA / ACV — get detailed information about an activity: name, location, exchanges, reference product, metadata. Use exchange_type / is_input / flow to filter exchanges and reduce response size.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivityInfo	—
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/flows

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: FlowSummary[]	—
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/inputs

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ExchangeDetail[]	—
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/outputs

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ExchangeDetail[]	—
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/reference-product

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: FlowDetail	—
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/tree

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: TreeExport	—
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/inventory

Operation ID: get_inventory

Summary: LCA / ACV — compute the Life Cycle Inventory (LCI): biosphere flows (emissions and resource extractions) for an activity's full supply chain.

LCA / ACV — compute the Life Cycle Inventory (LCI): biosphere flows (emissions and resource extractions) for an activity's full supply chain. Returns statistics and top flows by quantity. Use this (not get_impacts) when the question targets raw physical flows rather than weighted scores: land / pasture occupation (m²·year), water withdrawal (m³), specific emissions (kg CO₂, kg CH₄, kg N), resource extraction.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: InventoryExport	—
404	`dbName` or `processId` not found	`dbName` or `processId` not found

POST /api/v1/db/{dbName}/activity/{processId}/inventory

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—

Request body

Media type	Schema
application/json;charset=utf-8	SubstitutionRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: InventoryExport	—
400	Invalid `body`	Invalid `body`
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/graph

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
cutoff	query	no	number	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: GraphExport	—
400	Invalid `cutoff`	Invalid `cutoff`
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/supply-chain

Operation ID: get_supply_chain

Summary: LCA / ACV — get a flat list of all upstream activities in the supply chain (chaîne amont, filière, intrants).

LCA / ACV — get a flat list of all upstream activities in the supply chain (chaîne amont, filière, intrants). The 'quantity' field is the cumulative scaled amount relative to the functional unit (scaling_factor × root reference product amount). To get the per-step yield ratio between two connected entries, divide the supplier's scaling_factor by the consumer's scaling_factor.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
name	query	no	string	Filter by activity name
limit	query	no	integer	Max results (default 100)
min-quantity	query	no	number	—
offset	query	no	integer	—
max-depth	query	no	integer	—
location	query	no	string	Filter by location
product	query	no	string	—
preset	query	no	string	Name of a classification preset (from list_presets) — expands to its bundled filters. Unioned with any explicit classification / classification_value / classification_mode parameters.
classification	query	no	string[]	Classification system name (e.g. 'Category', 'Category type')
classification-value	query	no	string[]	—
classification-mode	query	no	string[]	—
sort	query	no	string	—
order	query	no	string	—
include-edges	query	no	boolean	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: SupplyChainResponse	—
400	Invalid `include-edges` or `order` or `sort` or `classification-mode` or `classification-value` or `classification` or `preset` or `product` or `location` or `max-depth` or `offset` or `min-quantity` or `limit` or `name`	Invalid `include-edges` or `order` or `sort` or `classification-mode` or `classification-value` or `classification` or `preset` or `product` or `location` or `max-depth` or `offset` or `min-quantity` or `limit` or `name`
404	`dbName` or `processId` not found	`dbName` or `processId` not found

POST /api/v1/db/{dbName}/activity/{processId}/supply-chain

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
name	query	no	string	—
limit	query	no	integer	—
min-quantity	query	no	number	—
offset	query	no	integer	—
max-depth	query	no	integer	—
location	query	no	string	—
product	query	no	string	—
preset	query	no	string	—
classification	query	no	string[]	—
classification-value	query	no	string[]	—
classification-mode	query	no	string[]	—
sort	query	no	string	—
order	query	no	string	—
include-edges	query	no	boolean	—

Request body

Media type	Schema
application/json;charset=utf-8	SubstitutionRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: SupplyChainResponse	—
400	Invalid `body` or `include-edges` or `order` or `sort` or `classification-mode` or `classification-value` or `classification` or `preset` or `product` or `location` or `max-depth` or `offset` or `min-quantity` or `limit` or `name`	Invalid `body` or `include-edges` or `order` or `sort` or `classification-mode` or `classification-value` or `classification` or `preset` or `product` or `location` or `max-depth` or `offset` or `min-quantity` or `limit` or `name`
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/aggregate

Operation ID: aggregate

Summary: LCA / ACV — aggregate exchanges, supply chain entries, or biosphere flows with SQL group-by-style filters.

LCA / ACV — aggregate exchanges, supply chain entries, or biosphere flows with SQL group-by-style filters. One primitive replaces ad-hoc decomposition tools — express any 'how much X is in Y' question as one call. Also the right tool for 'combien de surface agricole / d'eau / d'énergie dans un produit ?' style questions via scope=biosphere or scope=supply_chain. Examples: - Total electricity in direct inputs: scope=direct, is_input=true, filter_name=Electricity, filter_unit=kWh - Mass breakdown of direct inputs: scope=direct, is_input=true, filter_unit=kg, group_by=name - Total energy across the supply chain: scope=supply_chain, max_depth=2, filter_classification=["Category type=energy:exact"] - Largest pasture occupation flow: scope=biosphere, filter_name=Occupation, pasture, group_by=name The filter_classification parameter accepts a list of strings in "System=Value[:exact]" form (default mode is 'contains').

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
scope	query	no	string	direct | supply_chain | biosphere
is_input	query	no	boolean	Only for scope=direct — true=inputs only, false=outputs only
max_depth	query	no	integer	Only for scope=supply_chain — max hops from the root activity
filter_name	query	no	string	Case-insensitive substring on flow/activity name
filter_name_not	query	no	string	Comma-separated substring exclude list
filter_unit	query	no	string	Exact unit name
preset	query	no	string	Name of a classification preset (from list_presets) — expanded and merged into filter_classification.
filter_classification	query	no	string[]	List of "System=Value[:exact]" strings; defaults to 'contains' mode
filter_target_name	query	no	string	Only for scope=direct technosphere — filter by upstream activity name
filter_exchange_type	query	no	string	—
filter_is_reference	query	no	boolean	Filter by reference-product flag (typically for outputs)
group_by	query	no	string	name | flow_id | name_prefix | unit | classification.<system> | location | target_name
aggregate	query	no	string	sum_quantity | count | share (default: sum_quantity)

Responses

Status	Schema	Description
200	application/json;charset=utf-8: Aggregation	—
400	Invalid `aggregate` or `group_by` or `filter_is_reference` or `filter_exchange_type` or `filter_target_name` or `filter_classification` or `preset` or `filter_unit` or `filter_name_not` or `filter_name` or `max_depth` or `is_input` or `scope`	Invalid `aggregate` or `group_by` or `filter_is_reference` or `filter_exchange_type` or `filter_target_name` or `filter_classification` or `preset` or `filter_unit` or `filter_name_not` or `filter_name` or `max_depth` or `is_input` or `scope`
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/impacts/{collection}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
collection	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: LCIABatchResult	—
404	`dbName` or `processId` or `collection` not found	`dbName` or `processId` or `collection` not found

POST /api/v1/db/{dbName}/activity/{processId}/impacts/{collection}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
collection	path	yes	string	—

Request body

Media type	Schema
application/json;charset=utf-8	SubstitutionRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: LCIABatchResult	—
400	Invalid `body`	Invalid `body`
404	`dbName` or `processId` or `collection` not found	`dbName` or `processId` or `collection` not found

GET /api/v1/db/{dbName}/activity/{processId}/impacts/{collection}/{methodId}

Operation ID: get_impacts

Summary: LCA / ACV — compute Life Cycle Impact Assessment (LCIA) scores for an activity.

LCA / ACV — compute Life Cycle Impact Assessment (LCIA) scores for an activity. Returns the score, functional unit, and top contributing elementary flows. Answers 'empreinte carbone / environmental footprint' questions. Covers all LCIA categories: climate change, acidification, eutrophication, land use, water scarcity, resource depletion. Prefer this over web estimates for grounded, database-backed answers.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
collection	path	yes	string	—
methodId	path	yes	string	—
top-flows	query	no	integer	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: LCIAResult	—
400	Invalid `top-flows`	Invalid `top-flows`
404	`dbName` or `processId` or `collection` or `methodId` not found	`dbName` or `processId` or `collection` or `methodId` not found

POST /api/v1/db/{dbName}/activity/{processId}/impacts/{collection}/{methodId}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
collection	path	yes	string	—
methodId	path	yes	string	—

Request body

Media type	Schema
application/json;charset=utf-8	SubstitutionRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: LCIAResult	—
400	Invalid `body`	Invalid `body`
404	`dbName` or `processId` or `collection` or `methodId` not found	`dbName` or `processId` or `collection` or `methodId` not found

GET /api/v1/db/{dbName}/activity/{processId}/consumers

Operation ID: get_consumers

Summary: LCA / ACV — find all activities that transitively consume (depend on) a given supplier.

LCA / ACV — find all activities that transitively consume (depend on) a given supplier. Returns a flat list, each with a crDepth field: 1 = direct consumer, 2 = consumer of consumer, etc. Useful for tracing downstream use of a raw material — e.g. finding transformed food products in Agribalyse that use a raw ingredient.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
name	query	no	string	Filter by name (case-insensitive substring)
location	query	no	string	Filter by geography/location (case-insensitive substring, e.g. 'FR', 'DE')
product	query	no	string	Filter by product name (case-insensitive substring)
preset	query	no	string	Name of a classification preset (from list_presets) — expands to its bundled filters
classification	query	no	string[]	Classification system name (e.g. 'ISIC rev.4 ecoinvent')
classification-value	query	no	string[]	—
classification-mode	query	no	string[]	—
limit	query	no	integer	Max results (default 1000)
offset	query	no	integer	—
max-depth	query	no	integer	—
sort	query	no	string	—
order	query	no	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: SearchResults_ConsumerResult	—
400	Invalid `order` or `sort` or `max-depth` or `offset` or `limit` or `classification-mode` or `classification-value` or `classification` or `preset` or `product` or `location` or `name`	Invalid `order` or `sort` or `max-depth` or `offset` or `limit` or `classification-mode` or `classification-value` or `classification` or `preset` or `product` or `location` or `name`
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/path-to

Operation ID: get_path_to

Summary: LCA / ACV — find the shortest supply chain path from a process to the first upstream activity whose name matches a pattern.

LCA / ACV — find the shortest supply chain path from a process to the first upstream activity whose name matches a pattern. Each step includes cumulative_quantity, scaling_factor, and local_step_ratio (upstream ÷ downstream scaling factors). total_ratio is the product of all local_step_ratio values — the end-to-end conversion factor.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
target	query	no	string	Case-insensitive name substring to stop at

Responses

Status	Schema	Description
200	application/json;charset=utf-8: JsonValue	—
400	Invalid `target`	Invalid `target`
404	`dbName` or `processId` not found	`dbName` or `processId` not found

GET /api/v1/db/{dbName}/activity/{processId}/analyze/{analyzerName}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
analyzerName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: JsonValue	—
404	`dbName` or `processId` or `analyzerName` not found	`dbName` or `processId` or `analyzerName` not found

GET /api/v1/db/{dbName}/activity/{processId}/contributing-flows/{collection}/{methodId}

Operation ID: get_contributing_flows

Summary: LCA / ACV — identify which elementary flows (emissions/resources) contribute most to a specific impact category.

LCA / ACV — identify which elementary flows (emissions/resources) contribute most to a specific impact category. Answers 'which emissions drive my climate change score?'

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
collection	path	yes	string	—
methodId	path	yes	string	—
limit	query	no	integer	Max flows to return, sorted by contribution (default 20)

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ContributingFlowsResult	—
400	Invalid `limit`	Invalid `limit`
404	`dbName` or `processId` or `collection` or `methodId` not found	`dbName` or `processId` or `collection` or `methodId` not found

GET /api/v1/db/{dbName}/activity/{processId}/contributing-activities/{collection}/{methodId}

Operation ID: get_contributing_activities

Summary: LCA / ACV — identify which upstream activities contribute most to a specific impact category.

LCA / ACV — identify which upstream activities contribute most to a specific impact category. Answers 'which suppliers drive my climate change score?' Uses exact matrix-based computation, valid even for cyclic supply chains.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
processId	path	yes	string	—
collection	path	yes	string	—
methodId	path	yes	string	—
limit	query	no	integer	Max processes to return, sorted by contribution (default 10)

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ContributingActivitiesResult	—
400	Invalid `limit`	Invalid `limit`
404	`dbName` or `processId` or `collection` or `methodId` not found	`dbName` or `processId` or `collection` or `methodId` not found

GET /api/v1/db/{dbName}/flow/{flowId}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
flowId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: FlowDetail	—
404	`dbName` or `flowId` not found	`dbName` or `flowId` not found

GET /api/v1/db/{dbName}/flow/{flowId}/activities

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
flowId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivitySummary[]	—
404	`dbName` or `flowId` not found	`dbName` or `flowId` not found

GET /api/v1/methods

Operation ID: list_methods

Summary: LCA / ACV — list all loaded LCIA methods (impact assessment methods like climate change, acidification, eutrophication, land use, water scarcity)..

LCA / ACV — list all loaded LCIA methods (impact assessment methods like climate change, acidification, eutrophication, land use, water scarcity).

Responses

Status	Schema	Description
200	application/json;charset=utf-8: MethodSummary[]	—

GET /api/v1/method/{methodId}

Parameters

Name	In	Required	Type	Description
methodId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: MethodDetail	—
404	`methodId` not found	`methodId` not found

GET /api/v1/method/{methodId}/factors

Parameters

Name	In	Required	Type	Description
methodId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: MethodFactorAPI[]	—
404	`methodId` not found	`methodId` not found

GET /api/v1/db/{dbName}/method/{methodId}/mapping

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
methodId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: MappingStatus	—
404	`dbName` or `methodId` not found	`dbName` or `methodId` not found

GET /api/v1/db/{dbName}/method/{methodId}/flow-mapping

Operation ID: get_flow_mapping

Summary: LCA / ACV — get the mapping between a method's characterization factors and database flows, showing match coverage..

LCA / ACV — get the mapping between a method's characterization factors and database flows, showing match coverage.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
methodId	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: FlowCFMapping	—
404	`dbName` or `methodId` not found	`dbName` or `methodId` not found

GET /api/v1/db/{dbName}/method/{methodId}/characterization

Operation ID: get_characterization

Summary: LCA / ACV — look up characterization factors for a method matched against database flows.

LCA / ACV — look up characterization factors for a method matched against database flows. Without 'flow' filter, returns top factors by absolute value. With 'flow', searches by name. Shows CF value, direction, matched database flow, and match strategy.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
methodId	path	yes	string	—
flow	query	no	string	Filter by flow name (case-insensitive substring, matches both method CF name and database flow name)
limit	query	no	integer	Max results (default 20)

Responses

Status	Schema	Description
200	application/json;charset=utf-8: CharacterizationResult	—
400	Invalid `limit` or `flow`	Invalid `limit` or `flow`
404	`dbName` or `methodId` not found	`dbName` or `methodId` not found

GET /api/v1/db/{dbName}/flows

Operation ID: search_flows

Summary: LCA / ACV — search for biosphere flows (emissions, resources) by name.

LCA / ACV — search for biosphere flows (emissions, resources) by name. Use this to locate specific substances (CO2, CH4, water, land occupation) before querying characterization factors or inventory contributions.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
q	query	no	string	—
lang	query	no	string	—
limit	query	no	integer	Max results (default 20)
offset	query	no	integer	—
sort	query	no	string	—
order	query	no	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: SearchResults_FlowSearchResult	—
400	Invalid `order` or `sort` or `offset` or `limit` or `lang` or `q`	Invalid `order` or `sort` or `offset` or `limit` or `lang` or `q`
404	`dbName` not found	`dbName` not found

GET /api/v1/db/{dbName}/activities

Operation ID: search_activities

Summary: LCA / ACV — search for activities (processes) by name, geography, product, classification, or preset.

LCA / ACV — search for activities (processes) by name, geography, product, classification, or preset. Returns a paginated list of matching activities with their process IDs. Entry point for any LCA/ACV question about a specific product or process — food (yaourt, steak, pain, lait, fromage), packaging (PET, verre, carton), matériaux, énergie, transport. Accepts non-technical synonyms: empreinte carbone, empreinte environnementale, impact environnemental, occupation des sols, surface agricole, prairie, pâturage, intrants, filière, chaîne amont.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
name	query	no	string	Name substring to search for (or exact name if exact=true)
geo	query	no	string	Geography/location filter (e.g. 'FR', 'DE', 'GLO')
product	query	no	string	Product name filter
exact	query	no	boolean	If true, name and geo must match exactly (case-insensitive equality) instead of substring search
preset	query	no	string	Name of a classification preset (from list_presets) — expands to its bundled filters. Can be combined with explicit classification filters.
classification	query	no	string[]	Classification system name to filter by (e.g. 'ISIC rev.4 ecoinvent', 'CPC'). Use list_classifications to see available systems.
classification-value	query	no	string[]	—
classification-mode	query	no	string[]	—
limit	query	no	integer	Max results (default 20)
offset	query	no	integer	—
sort	query	no	string	—
order	query	no	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: SearchResults_ActivitySummary	—
400	Invalid `order` or `sort` or `offset` or `limit` or `classification-mode` or `classification-value` or `classification` or `preset` or `exact` or `product` or `geo` or `name`	Invalid `order` or `sort` or `offset` or `limit` or `classification-mode` or `classification-value` or `classification` or `preset` or `exact` or `product` or `geo` or `name`
404	`dbName` not found	`dbName` not found

GET /api/v1/db/{dbName}/classifications

Operation ID: list_classifications

Summary: LCA / ACV — list classification systems in a database.

LCA / ACV — list classification systems in a database. Without 'system': returns system names and activity counts only (lightweight). With 'system': returns all values for that system. Add 'filter' to narrow values by substring.

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ClassificationSystem[]	—
404	`dbName` not found	`dbName` not found

POST /api/v1/db/{dbName}/impacts/{collection}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
collection	path	yes	string	—

Request body

Media type	Schema
application/json;charset=utf-8	BatchImpactsRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: BatchImpactsResponse	—
400	Invalid `body`	Invalid `body`
404	`dbName` or `collection` not found	`dbName` or `collection` not found

GET /api/v1/db

Operation ID: list_databases

Summary: LCA / ACV — list all loaded LCA databases (Agribalyse, ecoinvent, …).

LCA / ACV — list all loaded LCA databases (Agribalyse, ecoinvent, …). Call this first to discover which databases are available before searching.

Responses

Status	Schema	Description
200	application/json;charset=utf-8: DatabaseListResponse	—

POST /api/v1/db/{dbName}/load

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: LoadDatabaseResponse	—
404	`dbName` not found	`dbName` not found

POST /api/v1/db/{dbName}/unload

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`dbName` not found	`dbName` not found

POST /api/v1/db/{dbName}/relink

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: RelinkResponse	—
404	`dbName` not found	`dbName` not found

DELETE /api/v1/db/{dbName}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`dbName` not found	`dbName` not found

POST /api/v1/db/upload

Request body

Media type	Schema
application/json;charset=utf-8	UploadRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: UploadResponse	—
400	Invalid `body`	Invalid `body`

GET /api/v1/db/{dbName}/setup

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: DatabaseSetupInfo	—
404	`dbName` not found	`dbName` not found

POST /api/v1/db/{dbName}/add-dependency/{depName}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
depName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: DatabaseSetupInfo	—
404	`dbName` or `depName` not found	`dbName` or `depName` not found

POST /api/v1/db/{dbName}/remove-dependency/{depName}

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—
depName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: DatabaseSetupInfo	—
404	`dbName` or `depName` not found	`dbName` or `depName` not found

POST /api/v1/db/{dbName}/set-data-path

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—

Request body

Media type	Schema
application/json;charset=utf-8	JsonValue

Responses

Status	Schema	Description
200	application/json;charset=utf-8: DatabaseSetupInfo	—
400	Invalid `body`	Invalid `body`
404	`dbName` not found	`dbName` not found

POST /api/v1/db/{dbName}/finalize

Parameters

Name	In	Required	Type	Description
dbName	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`dbName` not found	`dbName` not found

GET /api/v1/method-collections

Responses

Status	Schema	Description
200	application/json;charset=utf-8: MethodCollectionListResponse	—

POST /api/v1/method-collections/{name}/load

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

POST /api/v1/method-collections/{name}/unload

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

DELETE /api/v1/method-collections/{name}

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

POST /api/v1/method-collections/upload

Request body

Media type	Schema
application/json;charset=utf-8	UploadRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: UploadResponse	—
400	Invalid `body`	Invalid `body`

GET /api/v1/flow-synonyms

Responses

Status	Schema	Description
200	application/json;charset=utf-8: RefDataListResponse	—

POST /api/v1/flow-synonyms/{name}/load

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

POST /api/v1/flow-synonyms/{name}/unload

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

DELETE /api/v1/flow-synonyms/{name}

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

POST /api/v1/flow-synonyms/upload

Request body

Media type	Schema
application/json;charset=utf-8	UploadRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: UploadResponse	—
400	Invalid `body`	Invalid `body`

GET /api/v1/flow-synonyms/{name}/groups

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: SynonymGroupsResponse	—
404	`name` not found	`name` not found

GET /api/v1/flow-synonyms/{name}/download

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/octet-stream: OctetStream	—
404	`name` not found	`name` not found

GET /api/v1/compartment-mappings

Responses

Status	Schema	Description
200	application/json;charset=utf-8: RefDataListResponse	—

POST /api/v1/compartment-mappings/{name}/load

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

POST /api/v1/compartment-mappings/{name}/unload

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

DELETE /api/v1/compartment-mappings/{name}

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

POST /api/v1/compartment-mappings/upload

Request body

Media type	Schema
application/json;charset=utf-8	UploadRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: UploadResponse	—
400	Invalid `body`	Invalid `body`

GET /api/v1/units

Responses

Status	Schema	Description
200	application/json;charset=utf-8: RefDataListResponse	—

POST /api/v1/units/{name}/load

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

POST /api/v1/units/{name}/unload

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

DELETE /api/v1/units/{name}

Parameters

Name	In	Required	Type	Description
name	path	yes	string	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ActivateResponse	—
404	`name` not found	`name` not found

POST /api/v1/units/upload

Request body

Media type	Schema
application/json;charset=utf-8	UploadRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: UploadResponse	—
400	Invalid `body`	Invalid `body`

GET /api/v1/logs

Parameters

Name	In	Required	Type	Description
since	query	no	integer	—

Responses

Status	Schema	Description
200	application/json;charset=utf-8: JsonValue	—
400	Invalid `since`	Invalid `since`

POST /api/v1/auth

Request body

Media type	Schema
application/json;charset=utf-8	LoginRequest

Responses

Status	Schema	Description
200	application/json;charset=utf-8: JsonValue	—
400	Invalid `body`	Invalid `body`

GET /api/v1/version

Responses

Status	Schema	Description
200	application/json;charset=utf-8: JsonValue	—

GET /api/v1/hosting

Responses

Status	Schema	Description
200	application/json;charset=utf-8: JsonValue	—

GET /api/v1/stats

Responses

Status	Schema	Description
200	application/json;charset=utf-8: JsonValue	—

GET /api/v1/classification-presets

Operation ID: list_presets

Summary: LCA / ACV — list named classification filter presets configured in this instance.

LCA / ACV — list named classification filter presets configured in this instance. Each preset bundles multiple (system, value, mode) classification filters under a human-readable label. Use the filter values from a preset as inputs to search_activities classification parameters.

Responses

Status	Schema	Description
200	application/json;charset=utf-8: ClassificationPresetInfo[]	—

GET /api/v1/openapi.json

Responses

Status	Schema	Description
200	application/json;charset=utf-8: JsonValue	—

Schemas

ActivityInfo

Type: object

Property	Required	Type	Description
activity	yes	ActivityForAPI	—
links	yes	ActivityLinks	—
metadata	yes	ActivityMetadata	—
statistics	yes	ActivityStats	—

ActivityForAPI

Type: object

Property	Required	Type	Description
allProducts	yes	ActivitySummary[]	—
classifications	yes	object	—
description	yes	string[]	—
exchanges	yes	ExchangeWithUnit[]	—
location	yes	string	—
name	yes	string	—
processId	yes	string	—
referenceProduct	no	string	—
referenceProductAmount	no	number	—
referenceProductUnit	no	string	—
synonyms	yes	object	—
unit	yes	string	—

ActivitySummary

Type: object

Property	Required	Type	Description
location	yes	string	—
name	yes	string	—
processId	yes	string	—
product	yes	string	—
productAmount	yes	number	—
productUnit	yes	string	—

ExchangeWithUnit

Type: object

Property	Required	Type	Description
exchange	yes	Exchange	—
flowCategory	yes	string	—
flowName	yes	string	—
targetActivity	no	string	—
targetLocation	no	string	—
targetProcessId	no	string	—
unitName	yes	string	—

Exchange

Type: oneOf(object | object)

UUID

Type: string

ActivityMetadata

Type: object

Property	Required	Type	Description
biosphereExchanges	yes	integer	—
hasReferenceProduct	yes	boolean	—
referenceProductFlow	no	UUID	—
technosphereInputs	yes	integer	—
totalFlows	yes	integer	—

ActivityStats

Type: object

Property	Required	Type	Description
inputCount	yes	integer	—
location	yes	string	—
outputCount	yes	integer	—
totalExchanges	yes	integer	—

ActivityLinks

Type: object

Property	Required	Type	Description
flowsUrl	yes	string	—
inputsUrl	yes	string	—
outputsUrl	yes	string	—
referenceProductUrl	no	string	—

FlowSummary

Type: object

Property	Required	Type	Description
flow	yes	Flow	—
role	yes	FlowRole	—
unitName	yes	string	—
usageCount	yes	integer	—

Flow

Type: object

Property	Required	Type	Description
cAS	no	string	—
category	yes	string	—
id	yes	UUID	—
name	yes	string	—
subcompartment	no	string	—
substanceId	no	integer	—
synonyms	yes	object	—
type	yes	FlowType	—
unitId	yes	UUID	—

FlowType

Type: string

Allowed values: Technosphere, Biosphere

FlowRole

Type: string

Allowed values: InputFlow, OutputFlow, ReferenceProductFlow

ExchangeDetail

Type: object

Property	Required	Type	Description
exchange	yes	Exchange	—
exchangeUnitName	yes	string	—
flow	yes	Flow	—
flowUnitName	yes	string	—
targetActivity	no	ActivitySummary	—
unit	yes	Unit	—

Unit

Type: object

Property	Required	Type	Description
comment	yes	string	—
id	yes	UUID	—
name	yes	string	—
symbol	yes	string	—

FlowDetail

Type: object

Property	Required	Type	Description
flow	yes	Flow	—
unitName	yes	string	—
usageCount	yes	integer	—

TreeExport

Type: object

Property	Required	Type	Description
edges	yes	TreeEdge[]	—
nodes	yes	object	—
tree	yes	TreeMetadata	—

TreeMetadata

Type: object

Property	Required	Type	Description
expandableNodes	yes	integer	—
leafNodes	yes	integer	—
loopNodes	yes	integer	—
maxDepth	yes	integer	—
rootId	yes	string	—
totalNodes	yes	integer	—

ExportNode

Type: object

Property	Required	Type	Description
childrenCount	yes	integer	—
compartment	no	string	—
depth	yes	integer	—
description	yes	string[]	—
id	yes	string	—
location	yes	string	—
loopTarget	no	string	—
name	yes	string	—
nodeType	yes	NodeType	—
parentId	no	string	—
unit	yes	string	—

NodeType

Type: string

Allowed values: ActivityNode, LoopNode, BiosphereEmissionNode, BiosphereResourceNode

TreeEdge

Type: object

Property	Required	Type	Description
edgeType	yes	EdgeType	—
flow	yes	FlowInfo	—
from	yes	string	—
quantity	yes	number	—
to	yes	string	—
unit	yes	string	—

FlowInfo

Type: object

Property	Required	Type	Description
category	yes	string	—
id	yes	UUID	—
name	yes	string	—

EdgeType

Type: string

Allowed values: TechnosphereEdge, BiosphereEmissionEdge, BiosphereResourceEdge

InventoryExport

Type: object

Property	Required	Type	Description
flows	yes	InventoryFlowDetail[]	—
metadata	yes	InventoryMetadata	—
statistics	yes	InventoryStatistics	—

InventoryMetadata

Type: object

Property	Required	Type	Description
emissionFlows	yes	integer	—
resourceFlows	yes	integer	—
rootActivity	yes	ActivitySummary	—
totalFlows	yes	integer	—

InventoryFlowDetail

Type: object

Property	Required	Type	Description
category	yes	string	—
flow	yes	Flow	—
isEmission	yes	boolean	—
quantity	yes	number	—
unitName	yes	string	—

InventoryStatistics

Type: object

Property	Required	Type	Description
emissionQuantity	yes	number	—
resourceQuantity	yes	number	—
topCategories	yes	object[][]	—
totalQuantity	yes	number	—

GraphExport

Type: object

Property	Required	Type	Description
edges	yes	GraphEdge[]	—
nodes	yes	GraphNode[]	—
unitGroups	yes	object	—

GraphNode

Type: object

Property	Required	Type	Description
label	yes	string	—
location	yes	string	—
nodeId	yes	integer	—
processId	yes	string	—
unit	yes	string	—
value	yes	number	—

GraphEdge

Type: object

Property	Required	Type	Description
flowName	yes	string	—
source	yes	integer	—
target	yes	integer	—
unit	yes	string	—
value	yes	number	—

SupplyChainResponse

Type: object

Property	Required	Type	Description
edges	yes	SupplyChainEdge[]	—
filteredActivities	yes	integer	—
root	yes	ActivitySummary	—
supplyChain	yes	SupplyChainEntry[]	—
totalActivities	yes	integer	—

SupplyChainEntry

Type: object

Property	Required	Type	Description
classifications	yes	object	—
databaseName	yes	string	—
depth	yes	integer	—
location	yes	string	—
name	yes	string	—
processId	yes	string	—
quantity	yes	number	—
scalingFactor	yes	number	—
unit	yes	string	—
upstreamCount	yes	integer	—

SupplyChainEdge

Type: object

Property	Required	Type	Description
edgeAmount	yes	number	—
edgeFrom	yes	string	—
edgeFromDb	yes	string	—
edgeTo	yes	string	—
edgeToDb	yes	string	—

Aggregation

Type: object

Property	Required	Type	Description
filteredCount	yes	integer	—
filteredTotal	yes	number	—
filteredUnit	no	string	—
groups	yes	AggregationGroup[]	—
scope	yes	string	—

AggregationGroup

Type: object

Property	Required	Type	Description
count	yes	integer	—
key	yes	string	—
quantity	yes	number	—
share	no	number	—
unit	no	string	—

LCIABatchResult

Type: object

Property	Required	Type	Description
availableNWsets	yes	string[]	—
normWeightSetName	no	string	—
results	yes	LCIAResult[]	—
scoringResults	yes	object	—
scoringUnits	yes	object	—
singleScore	no	number	—
singleScoreUnit	no	string	—

LCIAResult

Type: object

Property	Required	Type	Description
category	yes	string	—
damageCategory	yes	string	—
functionalUnit	yes	string	—
mappedFlows	yes	integer	—
methodId	yes	UUID	—
methodName	yes	string	—
normalizedScore	no	number	—
score	yes	number	—
topContributors	yes	FlowContributionEntry[]	—
unit	yes	string	—
weightedScore	no	number	—

FlowContributionEntry

Type: object

Property	Required	Type	Description
category	yes	string	—
cfValue	yes	number	—
compartment	no	string	—
contribution	yes	number	—
flowId	yes	string	—
flowName	yes	string	—
sharePct	yes	number	—

SubstitutionRequest

Type: object

Property	Required	Type	Description
substitutions	yes	Substitution[]	—

Substitution

Type: object

Property	Required	Type	Description
consumer	yes	string	—
from	yes	string	—
to	yes	string	—

SearchResults_ConsumerResult

Type: object

Property	Required	Type	Description
hasMore	yes	boolean	—
limit	yes	integer	—
offset	yes	integer	—
results	yes	ConsumerResult[]	—
searchTimeMs	yes	number	—
total	yes	integer	—

ConsumerResult

Type: object

Property	Required	Type	Description
depth	yes	integer	—
location	yes	string	—
name	yes	string	—
processId	yes	string	—
product	yes	string	—
productAmount	yes	number	—
productUnit	yes	string	—

JsonValue

Type: object

ContributingFlowsResult

Type: object

Property	Required	Type	Description
method	yes	string	—
topFlows	yes	FlowContributionEntry[]	—
totalScore	yes	number	—
unit	yes	string	—

ContributingActivitiesResult

Type: object

Property	Required	Type	Description
activities	yes	ActivityContribution[]	—
method	yes	string	—
totalScore	yes	number	—
unit	yes	string	—

ActivityContribution

Type: object

Property	Required	Type	Description
activityName	yes	string	—
contribution	yes	number	—
location	yes	string	—
processId	yes	string	—
productName	yes	string	—
sharePct	yes	number	—

MethodSummary

Type: object

Property	Required	Type	Description
category	yes	string	—
collection	yes	string	—
factorCount	yes	integer	—
id	yes	UUID	—
name	yes	string	—
unit	yes	string	—

MethodDetail

Type: object

Property	Required	Type	Description
category	yes	string	—
description	no	string	—
factorCount	yes	integer	—
id	yes	UUID	—
methodology	no	string	—
name	yes	string	—
unit	yes	string	—

MethodFactorAPI

Type: object

Property	Required	Type	Description
direction	yes	string	—
flowName	yes	string	—
flowRef	yes	UUID	—
value	yes	number	—

MappingStatus

Type: object

Property	Required	Type	Description
coverage	yes	number	—
dbBiosphereCount	yes	integer	—
mappedByCAS	yes	integer	—
mappedByName	yes	integer	—
mappedBySynonym	yes	integer	—
mappedByUUID	yes	integer	—
methodId	yes	UUID	—
methodName	yes	string	—
totalFactors	yes	integer	—
uniqueDbFlowsMatched	yes	integer	—
unmapped	yes	integer	—
unmappedFlows	yes	UnmappedFlowAPI[]	—

UnmappedFlowAPI

Type: object

Property	Required	Type	Description
direction	yes	string	—
flowName	yes	string	—
flowRef	yes	UUID	—

FlowCFMapping

Type: object

Property	Required	Type	Description
flows	yes	FlowCFEntry[]	—
matchedFlows	yes	integer	—
methodName	yes	string	—
methodUnit	yes	string	—
totalFlows	yes	integer	—

FlowCFEntry

Type: object

Property	Required	Type	Description
cfFlowName	no	string	—
cfValue	no	number	—
flowCategory	yes	string	—
flowId	yes	UUID	—
flowName	yes	string	—
matchStrategy	no	string	—

CharacterizationResult

Type: object

Property	Required	Type	Description
factors	yes	CharacterizationEntry[]	—
matches	yes	integer	—
method	yes	string	—
shown	yes	integer	—
unit	yes	string	—

CharacterizationEntry

Type: object

Property	Required	Type	Description
category	yes	string	—
cfUnit	yes	string	—
cfValue	yes	number	—
compartment	no	string	—
dbFlowName	yes	string	—
direction	yes	string	—
flowId	yes	string	—
flowUnit	yes	string	—
matchStrategy	yes	string	—
methodFlowName	yes	string	—

SearchResults_FlowSearchResult

Type: object

Property	Required	Type	Description
hasMore	yes	boolean	—
limit	yes	integer	—
offset	yes	integer	—
results	yes	FlowSearchResult[]	—
searchTimeMs	yes	number	—
total	yes	integer	—

FlowSearchResult

Type: object

Property	Required	Type	Description
category	yes	string	—
id	yes	UUID	—
name	yes	string	—
synonyms	yes	object	—
unitName	yes	string	—

SearchResults_ActivitySummary

Type: object

Property	Required	Type	Description
hasMore	yes	boolean	—
limit	yes	integer	—
offset	yes	integer	—
results	yes	ActivitySummary[]	—
searchTimeMs	yes	number	—
total	yes	integer	—

ClassificationSystem

Type: object

Property	Required	Type	Description
activityCount	yes	integer	—
name	yes	string	—
values	yes	string[]	—

BatchImpactsResponse

Type: object

Property	Required	Type	Description
invalid	yes	string[]	—
notFound	yes	string[]	—
results	yes	BatchImpactsEntry[]	—

BatchImpactsEntry

Type: object

Property	Required	Type	Description
activityName	yes	string	—
impacts	yes	LCIABatchResult	—
processId	yes	string	—

BatchImpactsRequest

Type: object

Property	Required	Type	Description
processIds	yes	string[]	—

DatabaseListResponse

Type: object

Property	Required	Type	Description
databases	yes	DatabaseStatusAPI[]	—

DatabaseStatusAPI

Type: object

Property	Required	Type	Description
activityCount	yes	integer	—
description	no	string	—
displayName	yes	string	—
format	no	string	—
isUploaded	yes	boolean	—
loadAtStartup	yes	boolean	—
name	yes	string	—
path	yes	string	—
status	yes	string	—

LoadDatabaseResponse

Type: oneOf(object | object)

DepLoadResult

Type: oneOf(object | object)

ActivateResponse

Type: object

Property	Required	Type	Description
database	no	DatabaseStatusAPI	—
message	yes	string	—
success	yes	boolean	—

RelinkResponse

Type: object

Property	Required	Type	Description
crossDBLinks	yes	integer	—
dbName	yes	string	—
dependsOn	yes	string[]	—
unresolvedAfter	yes	integer	—
unresolvedBefore	yes	integer	—

UploadResponse

Type: object

Property	Required	Type	Description
format	no	string	—
message	yes	string	—
slug	no	string	—
success	yes	boolean	—

UploadRequest

Type: object

Property	Required	Type	Description
description	no	string	—
fileData	yes	string	—
name	yes	string	—

DatabaseSetupInfo

Type: object

Property	Required	Type	Description
dsiActivityCount	yes	integer	—
dsiAvailablePaths	yes	object[][]	—
dsiCompleteness	yes	number	—
dsiCrossDBLinks	yes	integer	—
dsiDataPath	yes	string	—
dsiDisplayName	yes	string	—
dsiInputCount	yes	integer	—
dsiInternalLinks	yes	integer	—
dsiIsLoaded	yes	boolean	—
dsiIsReady	yes	boolean	—
dsiLocationFallbacks	yes	object[][]	—
dsiMissingSuppliers	yes	MissingSupplier[]	—
dsiName	yes	string	—
dsiSelectedDeps	yes	string[]	—
dsiSuggestions	yes	DependencySuggestion[]	—
dsiUnknownUnits	yes	string[]	—
dsiUnresolvedLinks	yes	integer	—

MissingSupplier

Type: object

Property	Required	Type	Description
msCount	yes	integer	—
msDetail	no	string	—
msLocation	no	string	—
msProductName	yes	string	—
msReason	yes	string	—

DependencySuggestion

Type: object

Property	Required	Type	Description
dsgDatabaseName	yes	string	—
dsgDisplayName	yes	string	—
dsgMatchCount	yes	integer	—

MethodCollectionListResponse

Type: object

Property	Required	Type	Description
methods	yes	MethodCollectionStatusAPI[]	—

MethodCollectionStatusAPI

Type: object

Property	Required	Type	Description
description	no	string	—
displayName	yes	string	—
format	no	string	—
isUploaded	yes	boolean	—
methodCount	yes	integer	—
name	yes	string	—
path	yes	string	—
status	yes	string	—

RefDataListResponse

Type: object

Property	Required	Type	Description
items	yes	RefDataStatusAPI[]	—

RefDataStatusAPI

Type: object

Property	Required	Type	Description
description	no	string	—
displayName	yes	string	—
entryCount	yes	integer	—
isAuto	yes	boolean	—
isUploaded	yes	boolean	—
name	yes	string	—
status	yes	string	—

SynonymGroupsResponse

Type: object

Property	Required	Type	Description
groups	yes	string[][]	—

OctetStream

Type: string

LoginRequest

Type: object

Property	Required	Type	Description
lrCode	yes	string	—

ClassificationPresetInfo

Type: object

Property	Required	Type	Description
description	no	string	—
filters	yes	ClassificationEntryInfo[]	—
label	yes	string	—
name	yes	string	—

ClassificationEntryInfo

Type: object

Property	Required	Type	Description
mode	yes	string	—
system	yes	string	—
value	yes	string	—