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: 86
Schemas: 133
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.
`PUT`	`/api/v1/db/{dbName}/activity/{processId}`	-	-
`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}`	`score_activity`	LCA / ACV - compute the full LCIA panel + every configured scoring set for an activity in one call.
`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}`	-	-
`POST`	`/api/v1/db/{dbName}/activity/{processId}/sensitivity/{collection}/{methodId}`	`compute_sensitivity`	LCA / ACV - sensitivity analysis: sweep relative perturbations of technosphere coefficients A_ij and report the resulting impact for each.
`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}/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-collection/{collection}/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}/method/{methodId}/explain-cf/{flowId}`	`explain_cf`	LCA / ACV - explain why one elementary flow scores with the characterization factor it does.
`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.
`POST`	`/api/v1/db/{dbName}/activities`	-	-
`GET`	`/api/v1/db/{dbName}/classifications`	`list_classifications`	LCA / ACV - list classification systems in a database.
`POST`	`/api/v1/db/{dbName}/impacts/{collection}`	`score_activities`	LCA / ACV - rank N activities against one scoring set in one call.
`GET`	`/api/v1/db`	`list_databases`	LCA / ACV - list all loaded LCA databases (Agribalyse, ecoinvent, …).
`POST`	`/api/v1/db/{dbName}/load`	`load_database`	LCA / ACV - load a configured database into memory so it can be queried.
`POST`	`/api/v1/db/{dbName}/unload`	`unload_database`	LCA / ACV - unload a database from memory to free RAM.
`POST`	`/api/v1/db/{dbName}/relink`	-	-
`GET`	`/api/v1/db/{dbName}/gap-report`	`get_gap_report`	LCA / ACV - supplier-gap report of a database: every input demand still unsupplied after internal resolution and cross-database linking, aggregated per (product, location, unit) and ranked by demanding edges.
`GET`	`/api/v1/db/{dbName}/quality-report`	`get_quality_report`	LCA / ACV - dataset-soundness report of a database, for the people who build or repair one: the structural defects a score cannot reveal.
`GET`	`/api/v1/db/{dbName}/computed-quality-report`	`get_computed_quality_report`	LCA / ACV - computed-checks report of a LOADED database: what the data computes, judged against the catalogue's own norms.
`GET`	`/api/v1/db/{dbName}/characterization-coverage`	`get_characterization_coverage`	LCA / ACV - characterization-coverage report of a database against the loaded LCIA method collections, for the people who maintain databases.
`POST`	`/api/v1/db/{dbName}/copy/{newName}`	-	-
`DELETE`	`/api/v1/db/{dbName}`	-	-
`POST`	`/api/v1/db/{dbName}/delete`	-	-
`POST`	`/api/v1/db/{dbName}/activity/{processId}/exchanges`	`edit_exchanges`	LCA / ACV - change what one activity consumes and emits, keeping the activity itself.
`POST`	`/api/v1/db/{dbName}/export`	-	-
`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`	-	-
`POST`	`/api/v1/method-collections/{name}/export`	-	-
`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

`PUT /api/v1/db/{dbName}/activity/{processId}`

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`processId`	`path`	yes	`string`	-

Request body

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

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: ActivityWriteResponse`	-
`400`	Invalid `body`	Invalid `body`
`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. Summing quantities across entries that feed each other (electricity high→medium→low voltage) double-counts the chain - use aggregate with scope=consumption for upstream totals.

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 - Total upstream electricity without double counting: scope=consumption, filter_name=electricity, filter_consumer_not=electricity - Grass eaten by cattle across the whole chain: scope=consumption, filter_name=grass, filter_consumer=cattle scope=supply_chain rows are cumulative productions: when a filtered product feeds another filtered product (electricity high→medium→low voltage), their sum double-counts the chain. scope=consumption has one row per scaled technosphere edge (product, supplier, consumer), so its sums are actual consumption events; the default total is gross throughput - exclude intra-family edges with filter_consumer_not to get the amount delivered outside the filtered family. Byproduct edges keep their negative sign. 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 \| consumption
`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 or scope=consumption - filter by supplier activity name
`filter_consumer`	`query`	no	`string`	Only for scope=consumption - case-insensitive substring on the consuming activity's name
`filter_consumer_not`	`query`	no	`string`	Only for scope=consumption - comma-separated consumer-name exclude list (each item is a substring; a name containing a comma cannot be expressed)
`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 \| consumer_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_consumer_not` or `filter_consumer` 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_consumer_not` or `filter_consumer` 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}`

Operation ID: score_activity

Summary: LCA / ACV - compute the full LCIA panel + every configured scoring set for an activity in one call.

LCA / ACV - compute the full LCIA panel + every configured scoring set for an activity in one call. Returns per-method impact scores, per-scoring-set aggregate scores, per-scoring-set indicator breakdown (one entry per scoring variable), display units, and a 'web_url' to the matching view. Use this when you would otherwise call get_impacts N times across every method of a collection - replaces N round-trips with one batched solve. Discover available scoring sets with list_scoring_sets. Render the 'web_url' as a clickable markdown link when presenting results to a human.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`processId`	`path`	yes	`string`	-
`collection`	`path`	yes	`string`	Method collection name (use list_methods to discover)
`exclude-long-term`	`query`	no	`boolean`	-

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: LCIABatchResult`	-
`400`	Invalid `exclude-long-term`	Invalid `exclude-long-term`
`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`	-
`exclude-long-term`	`query`	no	`boolean`	-

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` or `exclude-long-term`	Invalid `body` or `exclude-long-term`
`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. Each contributing flow carries 'match_kind' - how its factor was found, in the rung names documented on explain_cf; null means the method's tables never walked this flow (it arrived from a dependency database), not that it is uncharacterized. Ask explain_cf for the full story on one flow. The response includes a 'web_url' deep link to the impacts page in the VoLCA web UI - render it as a clickable markdown link when presenting results to a human.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`processId`	`path`	yes	`string`	-
`collection`	`path`	yes	`string`	Method collection name (from list_methods). Only needed when the same method UUID is loaded in more than one collection (e.g. two EF 3.1 versions); otherwise the single match is used, and an ambiguous UUID fails with the list of collections to choose from.
`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

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

Operation ID: compute_sensitivity

Summary: LCA / ACV - sensitivity analysis: sweep relative perturbations of technosphere coefficients A_ij and report the resulting impact for each.

LCA / ACV - sensitivity analysis: sweep relative perturbations of technosphere coefficients A_ij and report the resulting impact for each. Each perturbation specifies (consumer, supplier, delta) where 'delta' is relative: A_ij is multiplied by (1+delta). delta=+0.05 → +5%; delta=-1 removes the link. Returns the baseline impact plus one entry per perturbation with the new score and deltaImpact. Per-perturbation errors (no link, singular update) are returned in the entry; the sweep continues. Internally uses Sherman-Morrison rank-1 updates against the cached factorization (~4 ms per perturbation). V1: root DB only. The response includes a 'web_url' deep link to the sensitivity page in the VoLCA web UI - render it as a clickable markdown link when presenting results to a human.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`processId`	`path`	yes	`string`	-
`collection`	`path`	yes	`string`	Method collection name (from list_methods). Only needed when the same method UUID is loaded in more than one collection (e.g. two EF 3.1 versions); otherwise the single match is used, and an ambiguous UUID fails with the list of collections to choose from.
`methodId`	`path`	yes	`string`	-

Request body

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

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: SensitivityResponse`	-
`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`	-
`include-edges`	`query`	no	`boolean`	-

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: ConsumersResponse`	-
`400`	Invalid `include-edges` or `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 `include-edges` or `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}/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?'. Each flow carries 'match_kind' - how its factor was found, in the rung names documented on explain_cf; null means the method's tables never walked this flow (it arrived from a dependency database), not that it is uncharacterized. Ask explain_cf for the full story on one flow. The response includes a 'web_url' deep link to the contributing-flows page in the VoLCA web UI - render it as a clickable markdown link when presenting results to a human.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`processId`	`path`	yes	`string`	-
`collection`	`path`	yes	`string`	Method collection name (from list_methods). Only needed when the same method UUID is loaded in more than one collection (e.g. two EF 3.1 versions); otherwise the single match is used, and an ambiguous UUID fails with the list of collections to choose from.
`methodId`	`path`	yes	`string`	-
`limit`	`query`	no	`integer`	Max flows to return, sorted by contribution (default 20)
`exclude-long-term`	`query`	no	`boolean`	-

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: ContributingFlowsResult`	-
`400`	Invalid `exclude-long-term` or `limit`	Invalid `exclude-long-term` or `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. Each contributing activity carries a 'web_url' deep link to its page in the VoLCA web UI - render these as clickable markdown links when presenting results to a human so they can drill into a specific supplier.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`processId`	`path`	yes	`string`	-
`collection`	`path`	yes	`string`	Method collection name (from list_methods). Only needed when the same method UUID is loaded in more than one collection (e.g. two EF 3.1 versions); otherwise the single match is used, and an ambiguous UUID fails with the list of collections to choose from.
`methodId`	`path`	yes	`string`	-
`limit`	`query`	no	`integer`	Max processes to return, sorted by contribution (default 10)
`exclude-long-term`	`query`	no	`boolean`	-

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: ContributingActivitiesResult`	-
`400`	Invalid `exclude-long-term` or `limit`	Invalid `exclude-long-term` or `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-collection/{collection}/coverage`

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`collection`	`path`	yes	`string`	-

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: CollectionCoverage`	-
`404`	`dbName` or `collection` not found	`dbName` or `collection` 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}/method/{methodId}/explain-cf/{flowId}`

Operation ID: explain_cf

Summary: LCA / ACV - explain why one elementary flow scores with the characterization factor it does.

LCA / ACV - explain why one elementary flow scores with the characterization factor it does. Answers 'why this factor, and which line of the method was used?'. The 'explanation' field is a list of sentences written by the engine: relay them as they are rather than interpreting the codes yourself. 'outcome' is one of: 'characterized' (a factor applies), 'conversion_refused' (a factor was found but the flow's unit cannot be converted to the factor's basis, so the flow scores nothing), 'no_factor' (nothing in the method reaches this flow). 'match.rung' names how the factor was found: 'flow_id' (the method names this exact flow), 'same_unit_name' (a factor line declared in this flow's own unit), 'exact_name' (name and compartment match), 'long_term_default' (the method's default for long-term emissions), 'compartment_default' (the method's default for the whole compartment), 'cas_number' (a factor for the same substance by CAS), 'subcompartment_blind' (the factor is the same in every subcompartment), 'region_base_name' (the base substance, the name's region suffix being untagged by the method), 'energy_content' (the family factor per unit of energy, bridged by the flow's calorific value), 'ore_base_element' (the base element of a graded ore). 'steps_tried' lists the rungs tried before that one, including any refused by a subcompartment veto. 'match.unitConversion' names the bridge that carried the amount onto the factor's basis: 'same_unit', 'unknown_unit' (the flow's unit is not in the unit table, so the amount passed as declared), 'unit_converted', 'normalized_to_base_unit' (the factor is written as a result expression like 'kg CO2 eq', so the amount was brought to the flow's base unit), 'energy_content' (carried across dimensions by the flow's energy density). 'match.refusal' names why no bridge could: 'different_dimensions', 'no_base_unit', 'energy_bridge_failed'. A vetoed step names its rule in 'veto': 'different_receiving_medium' (the method writes sea-water lines and so meant to leave this foreign medium out), 'long_term_groundwater' (a long-term groundwater emission must not borrow a surface-fate factor). The response includes a 'web_url' deep link to the explain-cf page in the VoLCA web UI - render it as a clickable markdown link when presenting results to a human.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`methodId`	`path`	yes	`string`	-
`flowId`	`path`	yes	`string`	-

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: ExplainCFResult`	-
`404`	`dbName` or `methodId` or `flowId` not found	`dbName` or `methodId` or `flowId` 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

`POST /api/v1/db/{dbName}/activities`

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-

Request body

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

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: ActivityWriteResponse`	-
`400`	Invalid `body`	Invalid `body`
`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}`

Operation ID: score_activities

Summary: LCA / ACV - rank N activities against one scoring set in one call.

LCA / ACV - rank N activities against one scoring set in one call. Returns a columnar JSON shape: {scoring_set, scoring_unit, functional_unit?, columns, rows, not_found, invalid}. 'columns' is the header (['name', 'process_id', 'web_url', 'total', <indicator keys...>]) and 'rows' is a 2D array of scalars - one row per resolved activity. Hoisting the constant metadata once and packing each activity as a flat array of scalars makes this shape ~6× smaller than a row-shaped JSON for batches of 24+ activities. The top-level 'functional_unit' is only emitted when every resolved row shares the same one; otherwise it is dropped and 'functional_unit' appears as a per-row column instead (the 'columns' header reflects which shape was emitted). Per-method scores are NOT included - call score_activity on a specific process_id for that drill-down. Unresolved process IDs land in not_found / invalid. The chosen scoring set must be unambiguous: pass scoring_sets: ["<one>"] when the collection has more than one scoring set configured. The 'web_url' column on each row is a deep link to the activity's impacts page in the VoLCA web UI - render it as a clickable markdown link when presenting results to a human.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`collection`	`path`	yes	`string`	Method collection name
`top-flows`	`query`	no	`integer`	-
`exclude-long-term`	`query`	no	`boolean`	-

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` or `exclude-long-term` or `top-flows`	Invalid `body` or `exclude-long-term` or `top-flows`
`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`

Operation ID: load_database

Summary: LCA / ACV - load a configured database into memory so it can be queried.

LCA / ACV - load a configured database into memory so it can be queried. Its declared dependencies are loaded first (needed for cross-database flow linking). A database must be loaded before search/score/impact tools can target it; use list_databases to see which are configured. No effect if it is already loaded.

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`

Operation ID: unload_database

Summary: LCA / ACV - unload a database from memory to free RAM.

LCA / ACV - unload a database from memory to free RAM. The on-disk data is kept and the database can be reloaded later with load_database. Refuses if another loaded database still depends on it - unload the dependents first.

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`	-

Request body

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

Responses

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

`GET /api/v1/db/{dbName}/gap-report`

Operation ID: get_gap_report

Summary: LCA / ACV - supplier-gap report of a database: every input demand still unsupplied after internal resolution and cross-database linking, aggregated per (product, location, unit) and ranked by demanding edges.

LCA / ACV - supplier-gap report of a database: every input demand still unsupplied after internal resolution and cross-database linking, aggregated per (product, location, unit) and ranked by demanding edges. Each gap carries the blocking reason, the number of consumer edges and distinct consumers, the total demanded amount, and the top consuming processes. Answers 'what is missing to switch or complete this database's background dependency?' - typically read right after a relink.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`limit`	`query`	no	`integer`	Max gap entries to return, biggest first (default: all). The header counts always cover the full report, so a truncated list stays countable.

Responses

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

`GET /api/v1/db/{dbName}/quality-report`

Operation ID: get_quality_report

Summary: LCA / ACV - dataset-soundness report of a database, for the people who build or repair one: the structural defects a score cannot reveal.

LCA / ACV - dataset-soundness report of a database, for the people who build or repair one: the structural defects a score cannot reveal. All checks run on staged and loaded databases alike: entries without exactly one reference exchange, coproduct allocation percentages that don't sum to 100% (or blocks where only some coproducts carry one), entries duplicated outright (same name, location and reference product), non-finite amounts or a zero reference amount, missing metadata (description, classification, location, units absent from the registry), geography the source never declared - read off the dataset name (SimaPro writes 'Unspecified' in whole databases) or filled in by the loader - stored amounts that disagree with the formulas documenting them (mathematicalRelation, checked at parse time), distinct names that merge under SimaPro's 80-character truncation, exchanges without the pedigree scores their database otherwise carries, reference products nothing in the database consumes (expected for final products), land transformation whose 'to' and 'from' areas don't balance within an activity, oxygen-demand or organic-carbon measures in a physically impossible order (BOD5 above COD, or dissolved above total organic carbon), flow CAS numbers whose check digit does not confirm them, and individual allocation percentages outside the 0-100% range. Each finding carries a severity (danger, warning, info), the activity it was found on, and a readable detail. Answers 'is this dataset well formed?' - the complement of the supplier-gap report, which answers 'what is this database missing?'

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`limit`	`query`	no	`integer`	Max findings to return per check, worst first (default: all). Each check's offenderCount always covers its full list, so a truncated list stays countable.

Responses

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

`GET /api/v1/db/{dbName}/computed-quality-report`

Operation ID: get_computed_quality_report

Summary: LCA / ACV - computed-checks report of a LOADED database: what the data computes, judged against the catalogue's own norms.

LCA / ACV - computed-checks report of a LOADED database: what the data computes, judged against the catalogue's own norms. Scores every (activity, product) entry against one method collection (the single loaded one, or the 'collection' parameter) and reports: per-category score outliers, judged on a log scale within (category, reference-unit) groups by median/MAD - a mg-read-as-kg unit slip lands three orders of magnitude out; entries whose every category score is zero (empty or uncharacterized inventory); and negative category scores (info - legitimate where avoided-production credits or waste treatment dominate). Complements get_quality_report, which checks what the database STORES and runs on staged databases too; this one needs the matrices and a loaded method collection. Same finding shape: severity, the entry, a readable detail.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`collection`	`query`	no	`string`	Method collection to score the catalogue against. Defaults to the single loaded collection; required when several are loaded.
`limit`	`query`	no	`integer`	Max findings to return per check, worst first (default: all). Each check's offenderCount always covers its full list, so a truncated list stays countable.

Responses

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

`GET /api/v1/db/{dbName}/characterization-coverage`

Operation ID: get_characterization_coverage

Summary: LCA / ACV - characterization-coverage report of a database against the loaded LCIA method collections, for the people who maintain databases.

LCA / ACV - characterization-coverage report of a database against the loaded LCIA method collections, for the people who maintain databases. Surfaces the flows a method scores ONLY through a name bridge: VoLCA matches a factor to a flow that carries a different name for the same substance (via synonym or CAS number), so the flow is characterized here - but a tool that matches factors by their exact name has no such bridge and scores it as zero, silently. Each bridged flow is grouped under the name the method itself uses (its rename target). One entry per loaded collection, so two method versions can be compared side by side. Optionally filtered to a single collection. Answers 'which of this database's flow names would an exact-name tool fail to characterize?'

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`collection`	`query`	no	`string`	Restrict the report to one loaded method collection (from list_methods). If omitted, every loaded collection is reported, so two method versions can be compared side by side.
`limit`	`query`	no	`integer`	Max bridge groups to return per collection (default: all). Each collection's bridgeGroupCount always covers its full list, so a truncated list stays countable.

Responses

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

`POST /api/v1/db/{dbName}/copy/{newName}`

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`newName`	`path`	yes	`string`	-

Responses

Status	Schema	Description
`200`	`application/json;charset=utf-8: ActivateResponse`	-
`404`	`dbName` or `newName` not found	`dbName` or `newName` 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/{dbName}/delete`

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-

Request body

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

Responses

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

`POST /api/v1/db/{dbName}/activity/{processId}/exchanges`

Operation ID: edit_exchanges

Summary: LCA / ACV - change what one activity consumes and emits, keeping the activity itself.

LCA / ACV - change what one activity consumes and emits, keeping the activity itself. The only tool that writes data. Use it to adjust an imported dataset to the study at hand: drop a substance the scope excludes, correct an amount, add a supplier the dataset is missing. Everything the edit does not name stays as it is - classification, synonyms, parameters, pedigree, coproducts - which is why this exists rather than rewriting the activity. Only the inventory side is addressable: an input by its provider's process_id, a waste output by its treatment's process_id, a biosphere line by its flow id (from get_activity). The reference product and any coproduct are not reachable, because changing those changes what the activity IS. A selector that matches nothing is refused rather than silently doing nothing, and one that matches several lines edits all of them and says how many. Refused outright on a database the engine reads from its configuration: copy it first (that background data is shared with everyone). If the answer says transient, the edit is in memory only and an unload undoes it.

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-
`processId`	`path`	yes	`string`	-

Request body

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

Responses

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

`POST /api/v1/db/{dbName}/export`

Parameters

Name	In	Required	Type	Description
`dbName`	`path`	yes	`string`	-

Request body

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

Responses

Status	Schema	Description
`200`	`application/octet-stream: OctetStream`	-
`400`	Invalid `body`	Invalid `body`
`404`	`dbName` not found	`dbName` not found

`POST /api/v1/db/upload`

Parameters

Name	In	Required	Type	Description
`name`	`query`	no	`string`	-
`description`	`query`	no	`string`	-

Request body

Media type	Schema
`application/octet-stream`	`UploadChunk[]`

Responses

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

`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`

Parameters

Name	In	Required	Type	Description
`name`	`query`	no	`string`	-
`description`	`query`	no	`string`	-

Request body

Media type	Schema
`application/octet-stream`	`UploadChunk[]`

Responses

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

`POST /api/v1/method-collections/{name}/export`

Parameters

Name	In	Required	Type	Description
`name`	`path`	yes	`string`	-

Request body

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

Responses

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

`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`

Parameters

Name	In	Required	Type	Description
`name`	`query`	no	`string`	-
`description`	`query`	no	`string`	-

Request body

Media type	Schema
`application/octet-stream`	`UploadChunk[]`

Responses

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

`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`

Parameters

Name	In	Required	Type	Description
`name`	`query`	no	`string`	-
`description`	`query`	no	`string`	-

Request body

Media type	Schema
`application/octet-stream`	`UploadChunk[]`

Responses

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

`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`

Parameters

Name	In	Required	Type	Description
`name`	`query`	no	`string`	-
`description`	`query`	no	`string`	-

Request body

Media type	Schema
`application/octet-stream`	`UploadChunk[]`

Responses

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

`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
`activityName`	yes	`string`	-
`allProducts`	yes	`ActivitySummary[]`	-
`classifications`	yes	`object`	-
`description`	yes	`string[]`	-
`exchanges`	yes	`ExchangeWithUnit[]`	-
`location`	yes	`string`	-
`nativeType`	no	`NativeActivityType`	-
`processId`	yes	`string`	-
`productAmount`	no	`number`	-
`productName`	no	`string`	-
`productUnit`	no	`string`	-
`synonyms`	yes	`object`	-
`unit`	yes	`string`	-

`ActivitySummary`

Type: object

Property	Required	Type	Description
`activityName`	yes	`string`	-
`allocationFormula`	no	`string`	-
`allocationPercent`	no	`number`	-
`location`	yes	`string`	-
`nativeType`	no	`NativeActivityType`	-
`processId`	yes	`string`	-
`productAmount`	yes	`number`	-
`productName`	yes	`string`	-
`productUnit`	yes	`string`	-

`NativeActivityType`

Type: object

Property	Required	Type	Description
`code`	no	`integer`	-
`label`	yes	`string`	-
`source`	yes	`string`	Allowed values: ecospold2, simapro, ilcd
`special_code`	no	`integer`	-
`special_label`	no	`string`	-

`ExchangeWithUnit`

Type: object

Property	Required	Type	Description
`compartment`	no	`Compartment`	-
`exComment`	no	`string`	-
`exchange`	yes	`Exchange`	-
`flowName`	yes	`string`	-
`pedigree`	no	`Pedigree`	-
`targetActivityName`	no	`string`	-
`targetLocation`	no	`string`	-
`targetProcessId`	no	`string`	-
`unitName`	yes	`string`	-

`Exchange`

Type: oneOf(object | object | object)

`UUID`

Type: string

`TechRole`

Type: string

Allowed values: ReferenceProduct, Coproduct, ReferenceInput, Input

`Pedigree`

Type: object

Property	Required	Type	Description
`completeness`	yes	`integer`	-
`geographical`	yes	`integer`	-
`reliability`	yes	`integer`	-
`technological`	yes	`integer`	-
`temporal`	yes	`integer`	-

`BioDirection`

Type: string

Allowed values: Resource, Emission

`Compartment`

Type: object

Property	Required	Type	Description
`name`	yes	`string`	-
`sub`	no	`string`	-

`ActivityMetadata`

Type: object

Property	Required	Type	Description
`biosphereExchanges`	yes	`integer`	-
`hasReferenceProduct`	yes	`boolean`	-
`referenceProductFlow`	no	`UUID`	-
`technosphereInputs`	yes	`integer`	-
`totalFlows`	yes	`integer`	-
`wasteExchangesLinked`	yes	`integer`	-
`wasteExchangesOrphan`	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	`ApiFlow`	-
`role`	yes	`FlowRole`	-
`unitName`	yes	`string`	-
`usageCount`	yes	`integer`	-

`ApiFlow`

Type: oneOf(object | object | object)

Property	Required	Type	Description
`kind`	yes	`string`	Allowed values: technosphere, biosphere, unresolved

`TechnosphereFlow`

Type: object

Property	Required	Type	Description
`cAS`	no	`string`	-
`id`	yes	`UUID`	-
`name`	yes	`string`	-
`substanceId`	no	`integer`	-
`synonyms`	yes	`object`	-
`unitId`	yes	`UUID`	-

`BiosphereFlow`

Type: object

Property	Required	Type	Description
`cAS`	no	`string`	-
`compartment`	no	`Compartment`	-
`id`	yes	`UUID`	-
`name`	yes	`string`	-
`substanceId`	no	`integer`	-
`synonyms`	yes	`object`	-
`unitId`	yes	`UUID`	-

`FlowRole`

Type: string

Allowed values: InputFlow, OutputFlow, ReferenceProductFlow

`ExchangeDetail`

Type: object

Property	Required	Type	Description
`exchange`	yes	`Exchange`	-
`exchangeUnitName`	yes	`string`	-
`flow`	yes	`ApiFlow`	-
`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	`ApiFlow`	-
`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	`BiosphereFlow`	-
`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
`activityName`	yes	`string`	-
`classifications`	yes	`object`	-
`databaseName`	yes	`string`	-
`depth`	yes	`integer`	-
`location`	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[]`	-
`cutoffWaste`	yes	`CutoffWasteFlow[]`	-
`normWeightSetName`	no	`string`	-
`results`	yes	`LCIAResult[]`	-
`scoringIndicators`	yes	`object`	-
`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`	-
`matchKind`	no	`string`	-
`sharePct`	yes	`number`	-

`ScoringIndicator`

Type: object

Property	Required	Type	Description
`category`	yes	`string`	-
`value`	yes	`number`	-

`CutoffWasteFlow`

Type: object

Property	Required	Type	Description
`amount`	yes	`number`	-
`flowId`	yes	`UUID`	-
`flowName`	yes	`string`	-
`unit`	yes	`string`	-

`SubstitutionRequest`

Type: object

Property	Required	Type	Description
`substitutions`	yes	`Substitution[]`	-

`Substitution`

Type: object

Property	Required	Type	Description
`consumer`	no	`string`	-
`from`	yes	`string`	-
`to`	yes	`string`	-

`SensitivityResponse`

Type: object

Property	Required	Type	Description
`baseline`	yes	`LCIAResult`	-
`perturbed`	yes	`PerturbedEntry[]`	-

`PerturbedEntry`

Type: object

Property	Required	Type	Description
`deltaImpact`	no	`number`	-
`error`	no	`string`	-
`impact`	no	`LCIAResult`	-
`perturbation`	yes	`Perturbation`	-

`Perturbation`

Type: object

Property	Required	Type	Description
`consumer`	yes	`string`	-
`delta`	yes	`number`	-
`label`	no	`string`	-
`supplier`	yes	`string`	-

`SensitivityRequest`

Type: object

Property	Required	Type	Description
`perturbations`	yes	`Perturbation[]`	-

`ConsumersResponse`

Type: object

Property	Required	Type	Description
`edges`	yes	`SupplyChainEdge[]`	-
`results`	yes	`SearchResults_ConsumerResult`	-

`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
`activityName`	yes	`string`	-
`classifications`	yes	`object`	-
`depth`	yes	`integer`	-
`location`	yes	`string`	-
`processId`	yes	`string`	-
`productAmount`	yes	`number`	-
`productName`	yes	`string`	-
`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
`compartment`	no	`string`	-
`direction`	yes	`string`	-
`flowName`	yes	`string`	-
`flowRef`	yes	`UUID`	-
`location`	no	`string`	-
`unit`	no	`string`	-
`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`	-

`CollectionCoverage`

Type: object

Property	Required	Type	Description
`characterizedFlows`	yes	`integer`	-
`collection`	yes	`string`	-
`dbName`	yes	`string`	-
`totalFlows`	yes	`integer`	-

`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`	-

`ExplainCFResult`

Type: object

Property	Required	Type	Description
`explanation`	yes	`string[]`	-
`flow`	yes	`ExplainedFlowAPI`	-
`match`	no	`ExplainedMatchAPI`	-
`method`	yes	`string`	-
`methodUnit`	yes	`string`	-
`outcome`	yes	`string`	-
`regionalFactorCount`	yes	`integer`	-
`stepsTried`	yes	`ExplainedStepAPI[]`	-

`ExplainedFlowAPI`

Type: object

Property	Required	Type	Description
`cas`	no	`string`	-
`category`	yes	`string`	-
`compartment`	no	`string`	-
`id`	yes	`string`	-
`name`	yes	`string`	-
`unit`	yes	`string`	-

`ExplainedMatchAPI`

Type: object

Property	Required	Type	Description
`cfUnit`	yes	`string`	-
`cfValue`	yes	`number`	-
`matchStrategy`	yes	`string`	-
`methodCas`	no	`string`	-
`methodFlowName`	yes	`string`	-
`refusal`	no	`string`	-
`rung`	yes	`string`	-
`unitConversion`	no	`string`	-

`ExplainedStepAPI`

Type: object

Property	Required	Type	Description
`result`	yes	`string`	-
`rung`	yes	`string`	-
`veto`	no	`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`	-
`compartment`	no	`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`	-
`dependsOn`	yes	`string[]`	-
`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`	-

`RelinkRequest`

Type: object

Property	Required	Type	Description
`depDb`	no	`string`	-
`mappingCsv`	no	`string`	-

`GapReportAPI`

Type: object

Property	Required	Type	Description
`completeness`	yes	`number`	-
`crossDBLinks`	yes	`integer`	-
`dbName`	yes	`string`	-
`gaps`	yes	`GapEntryAPI[]`	-
`internalLinks`	yes	`integer`	-
`totalInputs`	yes	`integer`	-
`unresolvedEdges`	yes	`integer`	-
`unresolvedProducts`	yes	`integer`	-

`GapEntryAPI`

Type: object

Property	Required	Type	Description
`consumers`	yes	`integer`	-
`demandSum`	yes	`number`	-
`detail`	no	`string`	-
`edges`	yes	`integer`	-
`location`	yes	`string`	-
`name`	yes	`string`	-
`reason`	yes	`string`	-
`topConsumers`	yes	`GapConsumerAPI[]`	-
`unit`	yes	`string`	-

`GapConsumerAPI`

Type: object

Property	Required	Type	Description
`activityName`	yes	`string`	-
`edges`	yes	`integer`	-
`location`	yes	`string`	-
`processId`	yes	`string`	-
`productName`	yes	`string`	-

`QualityReportAPI`

Type: object

Property	Required	Type	Description
`allocationOutOfRange`	yes	`QualityCheckAPI`	-
`allocationSums`	yes	`QualityCheckAPI`	-
`dbName`	yes	`string`	-
`duplicateActivities`	yes	`QualityCheckAPI`	-
`formulaConsistency`	yes	`QualityCheckAPI`	-
`invalidCas`	yes	`QualityCheckAPI`	-
`landTransformationBalance`	yes	`QualityCheckAPI`	-
`missingMetadata`	yes	`QualityCheckAPI`	-
`missingPedigree`	yes	`QualityCheckAPI`	-
`oxygenDemandOrder`	yes	`QualityCheckAPI`	-
`processCount`	yes	`integer`	-
`referenceProduct`	yes	`QualityCheckAPI`	-
`suspiciousAmounts`	yes	`QualityCheckAPI`	-
`truncatedNameCollisions`	yes	`QualityCheckAPI`	-
`unconsumedProducts`	yes	`QualityCheckAPI`	-
`undeclaredGeography`	yes	`QualityCheckAPI`	-
`unmeasurableAmounts`	yes	`QualityCheckAPI`	-

`QualityCheckAPI`

Type: object

Property	Required	Type	Description
`applicable`	yes	`boolean`	-
`offenderCount`	yes	`integer`	-
`offenders`	yes	`QualityOffenderAPI[]`	-

`QualityOffenderAPI`

Type: object

Property	Required	Type	Description
`activityName`	yes	`string`	-
`detail`	yes	`string`	-
`location`	yes	`string`	-
`processId`	yes	`string`	-
`productName`	no	`string`	-
`severity`	yes	`Severity`	-

`Severity`

Type: string

Allowed values: danger, warning, info

`ComputedQualityReportAPI`

Type: object

Property	Required	Type	Description
`collection`	yes	`string`	-
`dbName`	yes	`string`	-
`negativeScores`	yes	`QualityCheckAPI`	-
`processCount`	yes	`integer`	-
`scoreOutliers`	yes	`QualityCheckAPI`	-
`zeroScores`	yes	`QualityCheckAPI`	-

`CoverageReportAPI`

Type: object

Property	Required	Type	Description
`collections`	yes	`CollectionBridgesAPI[]`	-
`dbName`	yes	`string`	-

`CollectionBridgesAPI`

Type: object

Property	Required	Type	Description
`bridgeGroupCount`	yes	`integer`	-
`bridgeGroups`	yes	`BridgeGroupAPI[]`	-
`characterizedFlows`	yes	`integer`	-
`collection`	yes	`string`	-
`totalFlows`	yes	`integer`	-

`BridgeGroupAPI`

Type: object

Property	Required	Type	Description
`bridgedFlows`	yes	`BridgedFlowAPI[]`	-
`cas`	no	`string`	-
`methodName`	yes	`string`	-

`BridgedFlowAPI`

Type: object

Property	Required	Type	Description
`flowName`	yes	`string`	-
`strategy`	yes	`string`	-

`DeleteSelectionResponse`

Type: object

Property	Required	Type	Description
`deleted`	yes	`integer`	-
`message`	yes	`string`	-
`success`	yes	`boolean`	-
`transient`	yes	`boolean`	-
`warnings`	yes	`string[]`	-

`DeleteSelectionRequest`

Type: object

Property	Required	Type	Description
`classifications`	yes	`DeleteClassFilter[]`	-
`exact`	no	`boolean`	-
`extra`	yes	`string[]`	-
`ids`	no	`string[]`	-
`keep`	yes	`string[]`	-
`location`	no	`string`	-
`name`	no	`string`	-
`product`	no	`string`	-

`DeleteClassFilter`

Type: object

Property	Required	Type	Description
`exact`	yes	`boolean`	-
`system`	yes	`string`	-
`value`	yes	`string`	-

`ActivityWriteResponse`

Type: object

Property	Required	Type	Description
`transient`	yes	`boolean`	-
`warnings`	yes	`string[]`	-
`written`	yes	`string[]`	-

`ActivityWriteRequest`

Type: object

Property	Required	Type	Description
`activities`	yes	`ActivityInput[]`	-

`ActivityInput`

Type: object

Property	Required	Type	Description
`biosphere`	yes	`BioExchangeAPI[]`	-
`description`	yes	`string[]`	-
`inputs`	yes	`TechInputAPI[]`	-
`location`	yes	`string`	-
`name`	yes	`string`	-
`productAmount`	yes	`number`	-
`productName`	yes	`string`	-
`productUnit`	yes	`string`	-
`wasteOutputs`	yes	`WasteOutputAPI[]`	-

`TechInputAPI`

Type: object

Property	Required	Type	Description
`amount`	yes	`number`	-
`comment`	no	`string`	-
`provider`	yes	`string`	-
`unit`	no	`string`	-

`BioExchangeAPI`

Type: object

Property	Required	Type	Description
`amount`	yes	`number`	-
`comment`	no	`string`	-
`compartment`	no	`string`	-
`direction`	yes	`string`	-
`flow`	no	`string`	-
`name`	no	`string`	-
`subCompartment`	no	`string`	-
`unit`	no	`string`	-

`WasteOutputAPI`

Type: object

Property	Required	Type	Description
`amount`	yes	`number`	-
`comment`	no	`string`	-
`provider`	yes	`string`	-
`unit`	no	`string`	-

`ExchangeEditResponse`

Type: object

Property	Required	Type	Description
`added`	yes	`integer`	-
`amountsSet`	yes	`integer[]`	-
`removed`	yes	`integer[]`	-
`transient`	yes	`boolean`	-
`warnings`	yes	`string[]`	-

`ExchangeEditRequest`

Type: object

Property	Required	Type	Description
`addBiosphere`	yes	`BioExchangeAPI[]`	-
`addInputs`	yes	`TechInputAPI[]`	-
`addWasteOutputs`	yes	`WasteOutputAPI[]`	-
`remove`	yes	`ExchangeSelectorAPI[]`	-
`setAmounts`	yes	`SetAmountAPI[]`	-

`ExchangeSelectorAPI`

Type: object

Property	Required	Type	Description
`flow`	no	`string`	-
`kind`	yes	`string`	-
`provider`	no	`string`	-

`SetAmountAPI`

Type: object

Property	Required	Type	Description
`amount`	yes	`number`	-
`select`	yes	`ExchangeSelectorAPI`	-

`OctetStream`

Type: string

`ExportRequest`

Type: object

Property	Required	Type	Description
`format`	yes	`string`	-

`UploadResponse`

Type: object

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

`UploadChunk`

Type: string

`DatabaseSetupInfo`

Type: object

Property	Required	Type	Description
`activityCount`	yes	`integer`	-
`attributeFallbacks`	yes	`AttributeFallback[]`	-
`availablePaths`	yes	`PathCandidate[]`	-
`completeness`	yes	`number`	-
`crossDBLinks`	yes	`integer`	-
`dataPath`	yes	`string`	-
`dependencies`	yes	`DependencyChoice[]`	-
`displayName`	yes	`string`	-
`inputCount`	yes	`integer`	-
`internalLinks`	yes	`integer`	-
`isLoaded`	yes	`boolean`	-
`isReady`	yes	`boolean`	-
`locationFallbacks`	yes	`LocationFallback[]`	-
`locationUnresolved`	yes	`LocationUnresolved[]`	-
`missingSuppliers`	yes	`MissingSupplier[]`	-
`name`	yes	`string`	-
`unknownUnits`	yes	`string[]`	-
`unresolvedLinks`	yes	`integer`	-

`MissingSupplier`

Type: object

Property	Required	Type	Description
`count`	yes	`integer`	-
`detail`	no	`string`	-
`location`	no	`string`	-
`productName`	yes	`string`	-
`reason`	yes	`string`	-

`DependencyChoice`

Type: object

Property	Required	Type	Description
`databaseName`	yes	`string`	-
`displayName`	yes	`string`	-
`matchCount`	yes	`integer`	-
`status`	yes	`DependencyStatus`	-

`DependencyStatus`

Type: string

Allowed values: selected, available, redundant

`LocationFallback`

Type: object

Property	Required	Type	Description
`actual`	yes	`string`	-
`kind`	yes	`LocationKind`	-
`product`	yes	`string`	-
`requested`	yes	`string`	-

`LocationKind`

Type: string

Allowed values: exact, parent, global, unrelated

`LocationUnresolved`

Type: object

Property	Required	Type	Description
`product`	yes	`string`	-
`reason`	yes	`string`	-
`requested`	yes	`string`	-

`AttributeFallback`

Type: object

Property	Required	Type	Description
`matched`	yes	`string`	-
`product`	yes	`string`	-
`requested`	yes	`string`	-
`sourceDatabase`	yes	`string`	-

`PathCandidate`

Type: object

Property	Required	Type	Description
`fileCount`	yes	`integer`	-
`format`	yes	`string`	-
`path`	yes	`string`	-

`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[][]`	-

`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`	-