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.
- OpenAPI version:
3.0.0
- Operations:
141
- Schemas:
311
- Live server Swagger UI:
/api/v1/docs
- Live server OpenAPI JSON:
/api/v1/openapi.json
| Method | Path | Operation ID | Summary |
|---|
GET | /api/v1/db/{dbName}/activity/{processId} | get_activity | LCA / ACV: one activity in detail: name, location, exchanges, reference product, metadata, parameters its formulas read (own and database's), input uncertainty. |
PUT | /api/v1/db/{dbName}/activity/{processId} | - | - |
GET | /api/v1/db/{dbName}/activity/{processId}/division | - | - |
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: Life Cycle Inventory (LCI) of an activity's whole chain: biosphere flows (emissions, extractions) as statistics and top flows by quantity. |
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: flat list of all upstream activities (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: sum exchanges, supply-chain entries or biosphere flows with group-by filters: any 'how much X in Y' in one call, e.g. |
GET | /api/v1/db/{dbName}/activity/{processId}/impacts/{collection} | score_activity | LCA / ACV: an activity's full LCIA panel and every configured scoring set in one call: per-method scores, per-set scores and indicator breakdown (one entry per scoring variable), display units, 'web_url'. |
POST | /api/v1/db/{dbName}/activity/{processId}/impacts/{collection} | - | - |
GET | /api/v1/db/{dbName}/activity/{processId}/impacts/{collection}/{methodId} | get_impacts | LCA / ACV: LCIA score of an activity for one impact category, with functional unit and top contributing flows. |
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: score relative perturbations of technosphere coefficients. |
POST | /api/v1/db/{dbName}/activity/{processId}/reduced-model/{collection} | get_reduced_model | LCA / ACV: an activity's scores as a function of some input parameters, to run many values outside the engine (Monte Carlo, Sobol). |
GET | /api/v1/db/{dbName}/activity/{processId}/consumers | get_consumers | LCA / ACV: every activity consuming a supplier, directly or not, as a flat list; crDepth 1 = direct consumer, 2 = consumer's consumer… Traces a raw material downstream, e.g. |
GET | /api/v1/db/{dbName}/activity/{processId}/path-to | get_path_to | LCA / ACV: shortest supply-chain path from a process to the first upstream activity whose name matches a pattern. |
GET | /api/v1/db/{dbName}/activity/{processId}/compare | compare_activities | LCA / ACV: compare two activities line by line: lines only one has, lines whose amount or unit differ. |
POST | /api/v1/db/{dbName}/activity/{processId}/changes-present | - | - |
POST | /api/v1/db/{dbName}/activity/{processId}/apply-changes | - | - |
GET | /api/v1/db/{dbName}/activity/{processId}/contributing-flows/{collection}/{methodId} | get_contributing_flows | LCA / ACV: elementary flows (emissions, resources) weighing most in one impact category: 'which emissions drive my climate change score?'. |
GET | /api/v1/db/{dbName}/activity/{processId}/contributing-activities/{collection}/{methodId} | get_contributing_activities | LCA / ACV: upstream activities weighing most in one impact category: 'which suppliers drive my climate change score?'. |
GET | /api/v1/db/{dbName}/activity/{processId}/contributing-flows/{collection}/score/{scoringSet}/{score} | get_score_contributing_flows | LCA / ACV: elementary flows weighing most in one score of a scoring set (one number weighing a collection's indicators; list_scoring_sets): 'which emissions drive my single score?'. |
GET | /api/v1/db/{dbName}/activity/{processId}/contributing-activities/{collection}/score/{scoringSet}/{score} | get_score_contributing_activities | LCA / ACV: upstream activities weighing most in one score of a scoring set (list_scoring_sets): 'which suppliers drive my single score?'. |
GET | /api/v1/db/{dbName}/flow/{flowId} | - | - |
GET | /api/v1/db/{dbName}/flow/{flowId}/activities | - | - |
GET | /api/v1/db/{dbName}/flow/{flowId}/factors | get_flow_factors | LCA / ACV: which impact categories count one elementary flow, with what factor, in every loaded collection (or one): 'does this emission count anywhere?' in one call; explain_cf answers one method at a time. |
GET | /api/v1/methods | list_methods | LCA / ACV: loaded LCIA methods, one per impact category (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: how a method's characterization factors map onto database flows, with match coverage.. |
GET | /api/v1/db/{dbName}/method-collection/{collection}/coverage | - | - |
GET | /api/v1/db/{dbName}/method/{methodId}/characterization | get_characterization | LCA / ACV: a method's characterization factors matched to database flows. |
GET | /api/v1/db/{dbName}/method/{methodId}/explain-cf/{flowId} | explain_cf | LCA / ACV: why one elementary flow scores with its characterization factor, and which method line applied. |
GET | /api/v1/db/{dbName}/flows | search_flows | LCA / ACV: search flows by name. |
GET | /api/v1/db/{dbName}/search-counts | count_search_matches | LCA / ACV: how many processes, products and flows one query matches in a database, one call. |
GET | /api/v1/db/{dbName}/activities | search_activities | LCA / ACV: search 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: a database's classification systems. |
GET | /api/v1/db/{dbName}/catalogue | - | - |
GET | /api/v1/db/{dbName}/catalogue/fingerprint | - | - |
GET | /api/v1/db/{dbName}/compare | compare_databases | LCA / ACV: compare two loaded databases, usually two versions: activities added, removed, changed (with compare_activities' detail). |
GET | /api/v1/db/{dbName}/score-pairs | - | - |
POST | /api/v1/db/{dbName}/score-units | - | - |
POST | /api/v1/db/{dbName}/impacts/{collection} | score_activities | LCA / ACV: rank N activities on one scoring set, one call. |
POST | /api/v1/db/{dbName}/impacts/{collection}/{methodId} | - | - |
GET | /api/v1/db | list_databases | LCA / ACV: list loaded LCA databases (Agribalyse, ecoinvent…). |
POST | /api/v1/db/{dbName}/load | load_database | LCA / ACV: load a configured database into memory, its declared dependencies first (cross-database links). |
POST | /api/v1/db/{dbName}/unload | unload_database | LCA / ACV: unload a database to free memory; files stay, load_database reloads it. |
POST | /api/v1/db/{dbName}/relink | - | - |
GET | /api/v1/db/{dbName}/gap-report | get_gap_report | LCA / ACV: supplier gaps of a database: input demands still unsupplied after internal resolution and cross-database linking, per (product, supplier activity named, location, unit), ranked by demanding edges. |
GET | /api/v1/db/{dbName}/quality-report | get_quality_report | LCA / ACV: soundness report of a database, staged or loaded, for those who build or repair one: structural defects a score cannot show. |
GET | /api/v1/db/{dbName}/quality-report.csv | - | - |
GET | /api/v1/db/{dbName}/computed-quality-report | get_computed_quality_report | LCA / ACV: computed checks of a LOADED database, judged against the catalogue's own norms. |
GET | /api/v1/db/{dbName}/computed-quality-report.csv | - | - |
GET | /api/v1/db/{dbName}/characterization-coverage | get_characterization_coverage | LCA / ACV: characterization coverage of a database against loaded collections, for maintainers. |
POST | /api/v1/db/{dbName}/copy/{newName} | - | - |
POST | /api/v1/db/{dbName}/derive/{newName} | derive_database | LCA / ACV: make a parent or child of a database under a new name. |
GET | /api/v1/db/{dbName}/system-model | - | - |
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, or its name, location, description, keeping the activity: the tool that writes data. |
POST | /api/v1/db/{dbName}/activities/exchanges | edit_activities | edit_exchanges on several activities as one change: all edits judged first, all refused if one is; database rebuilt and relinked once (most of an edit's cost when large). |
POST | /api/v1/db/{dbName}/missing-suppliers/supply | supply_missing_product | Give a missing product a supplier for every activity lacking it: each unanswered input asking for this product (and naming supplier_activity, if given) moves to the provider, keeping amount, formula, comment, as edit_activities' set_suppliers would. |
POST | /api/v1/db/{dbName}/export | - | - |
GET | /api/v1/db/{dbName}/files/{path} | - | - |
PUT | /api/v1/db/{dbName}/licence | - | - |
PUT | /api/v1/db/{dbName}/release | - | - |
PUT | /api/v1/db/{dbName}/display-name | - | - |
PUT | /api/v1/db/{dbName}/description | - | - |
POST | /api/v1/db/{dbName}/accept-substitution | - | - |
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 | - | - |
GET | /api/v1/method-collections/available | - | - |
POST | /api/v1/method-collections/available/{name}/install | - | - |
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/method-collections/{collection}/compare | compare_method_collections | LCA / ACV: compare two loaded method collections, usually two versions or ports of a method: per category pair, factors added, removed, changed (both values and ratio). |
GET | /api/v1/method-collections/{collection}/profile | profile_method_collection | LCA / ACV: what each category of a loaded collection holds, without listing factors: factors per medium ('media', none for unfiled), how many written for one location and over how many locations, how many carry it at the end of the name ('Ammonia, FR'), how many zero, how many pattern or exclusion rows, and duplicates (one key, one place: a comparison cannot pair them). |
POST | /api/v1/method-collections/{collection}/copy/{newName} | copy_method_collection | LCA / ACV: copy a method collection under a new name, to change it. |
POST | /api/v1/method-collections/{collection}/factors | edit_method_factors | LCA / ACV: in a loaded collection of one's own (copy or upload), change, remove or add one characterization factor, or rescale or set every factor a selector reaches. |
POST | /api/v1/method-collections/{collection}/categories | edit_method_categories | LCA / ACV: in a loaded collection of one's own (copy or upload), add, rename, re-unit or remove an impact category. |
GET | /api/v1/method-collections/{collection}/scoring-sets | list_scoring_sets | LCA / ACV: formula-based scoring sets of loaded collections, each aggregating category scores into weighted or normalized 'score' values (e.g. |
POST | /api/v1/method-collections/{collection}/scoring-sets | edit_scoring_sets | LCA / ACV: change scoring sets of a loaded collection of one's own (copy or upload), each named by 'set'. |
POST | /api/v1/method-collections/{collection}/undo | undo_method_edit | LCA / ACV: undo a change to a collection of one's own by writing its inverse as a new journal line. |
GET | /api/v1/method-collections/{collection}/history | get_method_history | LCA / ACV: a method collection's journal, one entry per change: line, when, what (category, factor, values before and after, selector and factors touched), whether it undoes another line, whether still in effect. |
GET | /api/v1/method-collections/{collection}/flows | search_method_flows | LCA / ACV: flows a loaded collection characterizes, once per direction and compartment, whose name holds every word of 'q' (case aside), by name. |
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/flow-synonyms/{name}/rows | - | - |
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/compartment-mappings/{name}/download | - | - |
GET | /api/v1/compartment-mappings/{name}/rows | - | - |
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/units/{name}/download | - | - |
GET | /api/v1/units/{name}/rows | - | - |
GET | /api/v1/logs | - | - |
GET | /api/v1/usage | - | - |
DELETE | /api/v1/usage | - | - |
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: this instance's classification filter presets: each a label over (system, value, mode) filters, for search_activities' classification parameters.. |
GET | /api/v1/licences | - | - |
GET | /api/v1/formula-language | get_formula_language | The formula language of parameters and exchanges: each function and operator with usage, meaning, worked example; operators by binding, loosest first; rules for numbers, names, arguments.. |
POST | /api/v1/db/{dbName}/formula-check | check_formula | Check a formula where it would be written, at the database's values: among a process's parameters ('process_id'), on one of its lines ('exchange', position among exchanges), or among database parameters if no process. |
GET | /api/v1/db/{dbName}/history | get_database_history | Every change to a database of one's own, oldest first: when; what, in words (activities added, rewritten, deleted; exchanges edited, amounts before and after; parameters changed); author's reason, if any; the 'database' it was made on. |
GET | /api/v1/db/{dbName}/parameters | get_database_parameters | A database's parameters, read by every process's formulas unless the process defines its own of that name: value (or formula and its value), unit, description, uncertainty. |
POST | /api/v1/db/{dbName}/parameters | edit_database_parameters | Set or remove a database's parameters, then restate every process reading them: a line whose formula no longer gives its amount takes the formula's value; the answer lists processes that moved. |
GET | /api/v1/db/{dbName}/scenarios | list_scenarios | A database's scenarios: name and parameter values, as {process?, name, value}. |
PUT | /api/v1/db/{dbName}/scenarios/{name} | save_scenario | Save parameter values on a database under a name, replacing what it held; the answer lists saved scenarios. |
DELETE | /api/v1/db/{dbName}/scenarios/{name} | drop_scenario | Drop a scenario saved on a database; the answer lists those left. |
GET | /api/v1/openapi.json | - | - |
GET /api/v1/db/{dbName}/activity/{processId}
Operation ID: get_activity
Summary: LCA / ACV: one activity in detail: name, location, exchanges, reference product, metadata, parameters its formulas read (own and database's), input uncertainty.
LCA / ACV: one activity in detail: name, location, exchanges, reference product, metadata, parameters its formulas read (own and database's), input uncertainty. exchange_type / is_input / flow filter exchanges. Metadata (description, documentation, source) comes with every filter; without hundreds of exchanges: exchange_type=technosphere, is_input=false.
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 | - |
note | query | no | string | - |
source | query | no | 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` or `source` or `note` | Invalid `body` or `source` or `note` |
404 | `dbName` or `processId` not found | `dbName` or `processId` not found |
GET /api/v1/db/{dbName}/activity/{processId}/division
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ProcessDivisionAPI | - |
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: Life Cycle Inventory (LCI) of an activity's whole chain: biosphere flows (emissions, extractions) as statistics and top flows by quantity.
LCA / ACV: Life Cycle Inventory (LCI) of an activity's whole chain: biosphere flows (emissions, extractions) as statistics and top flows by quantity. Use it, not get_impacts, for raw physical flows rather than weighted scores: land / pasture occupation (m²·year), water withdrawal (m³), emissions (kg CO₂, kg CH₄, kg N), resource extraction. Inputs no loaded database supplies count as zero: 'cutoff_notice' opens the answer, 'cutoff_inputs' lists them, 'withheld_cutoffs' counts those a licence hides.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
flow | query | no | string | Flow name or synonym, read as search_flows does: every word, case-blind, any order, punctuation optional |
limit | query | no | integer | Max flows, largest absolute quantity first. Default: 50 over MCP, all over HTTP |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: InventoryExport | - |
400 | Invalid `limit` or `flow` | Invalid `limit` or `flow` |
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 | - |
flow | query | no | string | - |
limit | query | no | integer | - |
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` or `limit` or `flow` | Invalid `body` or `limit` or `flow` |
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: flat list of all upstream activities (chaîne amont, filière, intrants).
LCA / ACV: flat list of all upstream activities (chaîne amont, filière, intrants). 'quantity': cumulative amount per functional unit (scaling_factor × root reference amount); step yield = supplier's scaling_factor ÷ consumer's. Summing entries feeding each other (electricity high→medium→low voltage) counts twice: use aggregate scope=consumption for totals. 'unit' is the producer's reference unit, which SimaPro and Brightway Excel imports write in the dimension's canonical unit (kg, mj, m3), so may differ from the consuming line's: 0.22 kWh shows in mj (1 kWh = 3.6 MJ). Read it off the entry. Inputs no loaded database supplies count as zero, in 'cutoffInputs'; 'withheldCutoffs' counts those a licence hides.
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 geography/location: that location, plus every location inside it ('US' also matches 'US-WECC'), case-insensitive |
product | query | no | string | - |
preset | query | no | string | Classification preset (list_presets), expanded to its filters; unioned with explicit classification filters. |
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: sum exchanges, supply-chain entries or biosphere flows with group-by filters: any 'how much X in Y' in one call, e.g.
LCA / ACV: sum exchanges, supply-chain entries or biosphere flows with group-by filters: any 'how much X in Y' in one call, e.g. 'combien de surface agricole / d'eau / d'énergie dans un produit ?' via scope=biosphere or scope=supply_chain. Examples:
- 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
- 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
- Upstream electricity without double counting: scope=consumption, filter_name=electricity, filter_consumer_not=electricity
- Grass eaten by cattle over the chain: scope=consumption, filter_name=grass, filter_consumer=cattle
scope=supply_chain rows are cumulative productions: a filtered product feeding another (electricity high→medium→low voltage) counts twice. scope=consumption: one row per scaled technosphere edge (product, supplier, consumer), so sums are real consumption; gross throughput by default, filter_consumer_not drops edges inside the family. Byproduct edges stay negative. filter_classification: "System=Value[:exact]" (default contains). Inputs no loaded database supplies count as zero, in 'cutoffInputs'; 'withheldCutoffs' counts those a licence hides.
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 | Whole unit name, case-insensitive: "MJ" and "mj" are the same unit, "kg" does not match "kgm" |
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: an activity's full LCIA panel and every configured scoring set in one call: per-method scores, per-set scores and indicator breakdown (one entry per scoring variable), display units, 'web_url'.
LCA / ACV: an activity's full LCIA panel and every configured scoring set in one call: per-method scores, per-set scores and indicator breakdown (one entry per scoring variable), display units, 'web_url'. One batched solve instead of get_impacts per method. list_scoring_sets names the sets. exchange_contributions splits each score by the activity's own lines, to group into stages (ingredients, transport, packaging). Inputs no loaded database supplies count as zero, in 'cutoffInputs'; 'withheldCutoffs' counts those a licence hides. 'basis': what the score rests on (engine and commit; each database read, its release, whether copied, edited, allocated otherwise or patched; method collection, whether a modified copy; substitutions and parameter values sent). Quote it with the number: scores compare only on the same basis. Show each 'web_url' as a clickable link: it opens the VoLCA page.
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 | - |
exchange-contributions | query | no | boolean | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: LCIABatchResult | - |
400 | Invalid `exchange-contributions` or `exclude-long-term` | Invalid `exchange-contributions` or `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 | - |
exchange-contributions | 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 `exchange-contributions` or `exclude-long-term` | Invalid `body` or `exchange-contributions` 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: LCIA score of an activity for one impact category, with functional unit and top contributing flows.
LCA / ACV: LCIA score of an activity for one impact category, with functional unit and top contributing flows. Answers empreinte carbone / environmental footprint questions, any category (climate change, acidification, eutrophication, land use, water scarcity, resource depletion); prefer it to web estimates. Flow 'match_kind': how its factor was found (rungs on explain_cf), null if none reaches it. 'probable_misses': flows scored without a factor though the method writes their substance elsewhere in their medium, at a subcompartment the flow does not read, where the collection writes nothing at the flow's own place; 'writtenAt' says where, 'upTo' what it would add at the largest of those factors, in the score's unit. 'basis' as on score_activity. Inputs no loaded database supplies count as zero: 'cutoff_notice' opens the answer, 'cutoff_inputs' lists them, 'withheld_cutoffs' counts those a licence hides. Show each 'web_url' as a clickable link: it opens the VoLCA page.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
collection | path | yes | string | Method collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them. |
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: score relative perturbations of technosphere coefficients.
LCA / ACV: sensitivity: score relative perturbations of technosphere coefficients. Each (consumer, supplier, delta) multiplies A_ij by (1+delta): +0.05 is +5%, -1 removes the link. Returns baseline, then per perturbation new score and deltaImpact; an error (no link, singular update) stays in its entry, the sweep goes on. Rank-1 updates on the cached factorization, ~4 ms each. Root database only. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
collection | path | yes | string | Method collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them. |
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 |
POST /api/v1/db/{dbName}/activity/{processId}/reduced-model/{collection}
Operation ID: get_reduced_model
Summary: LCA / ACV: an activity's scores as a function of some input parameters, to run many values outside the engine (Monte Carlo, Sobol).
LCA / ACV: an activity's scores as a function of some input parameters, to run many values outside the engine (Monte Carlo, Sobol). Parameters as get_activity lists them: {name} for the database's, {process, name} for a process's own. Per method of the collection: score at the database's values ('baseline'); processes these parameters move, with exchanges as formula trees, stored amounts, emission factors; suppliers' unit scores and the scaling each gives the moving processes; scoring sets as formulas over category totals. Refused when a parameter moves an allocation share, or more than 500 processes.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
collection | path | yes | string | Method collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them. |
exclude-long-term | query | no | boolean | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ReducedModelRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ReducedModel | - |
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}/consumers
Operation ID: get_consumers
Summary: LCA / ACV: every activity consuming a supplier, directly or not, as a flat list; crDepth 1 = direct consumer, 2 = consumer's consumer… Traces a raw material downstream, e.g.
LCA / ACV: every activity consuming a supplier, directly or not, as a flat list; crDepth 1 = direct consumer, 2 = consumer's consumer… Traces a raw material downstream, e.g. processed foods made with one 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 (e.g. 'FR', 'DE'): that location, plus every location inside it ('RER' also matches 'FR'), case-insensitive |
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: shortest supply-chain path from a process to the first upstream activity whose name matches a pattern.
LCA / ACV: shortest supply-chain path from a process to the first upstream activity whose name matches a pattern. Each step: cumulative_quantity, scaling_factor, local_step_ratio (upstream ÷ downstream scaling factor); total_ratio, their product, is 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}/compare
Operation ID: compare_activities
Summary: LCA / ACV: compare two activities line by line: lines only one has, lines whose amount or unit differ.
LCA / ACV: compare two activities line by line: lines only one has, lines whose amount or unit differ. Other activity may be in another loaded database (other_database): adapted copy vs original. Lines pair on flow id and role, then flow name (case, trailing ' {GEO}' and SimaPro's ' U'/' S' aside), compartment and role; 'match' says which ('SameFlow', 'SameFlowName'). Role is part of a line: input turned coproduct = one removed, one added. One flow's lines in one unit are summed; one line each side with another supplier = 'SupplierChanged' (each by activity name and location); several suppliers compare totals only. A flow in several units on one side: 'uncompared'. Amounts equal within relative 1e-9; units by name. 'summary': differing activity name, location, product name, allocation share, description, stated dates; product amount by its reference line. Nothing listed: same content.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
other_process_id | query | no | string | Process ID of the activity to compare against (activityUUID_productUUID format) |
other_database | query | no | string | Loaded database holding that activity, when it is not this one |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ActivityComparison | - |
400 | Invalid `other_database` or `other_process_id` | Invalid `other_database` or `other_process_id` |
404 | `dbName` or `processId` not found | `dbName` or `processId` not found |
POST /api/v1/db/{dbName}/activity/{processId}/changes-present
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ChangesQuery |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ChangesPresence | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` or `processId` not found | `dbName` or `processId` not found |
POST /api/v1/db/{dbName}/activity/{processId}/apply-changes
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ChangesQuery |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ChangesApplied | - |
400 | Invalid `body` | Invalid `body` |
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: elementary flows (emissions, resources) weighing most in one impact category: 'which emissions drive my climate change score?'.
LCA / ACV: elementary flows (emissions, resources) weighing most in one impact category: 'which emissions drive my climate change score?'. Flow 'match_kind': how its factor was found (rungs on explain_cf), null if none reaches it. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
collection | path | yes | string | Method collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them. |
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: upstream activities weighing most in one impact category: 'which suppliers drive my climate change score?'.
LCA / ACV: upstream activities weighing most in one impact category: 'which suppliers drive my climate change score?'. Exact matrix computation, valid for cyclic chains. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
collection | path | yes | string | Method collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them. |
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}/activity/{processId}/contributing-flows/{collection}/score/{scoringSet}/{score}
Operation ID: get_score_contributing_flows
Summary: LCA / ACV: elementary flows weighing most in one score of a scoring set (one number weighing a collection's indicators; list_scoring_sets): 'which emissions drive my single score?'.
LCA / ACV: elementary flows weighing most in one score of a scoring set (one number weighing a collection's indicators; list_scoring_sets): 'which emissions drive my single score?'. Contribution = weighted sum over indicators, so flows add up to score_activity's score. 'cf_value': what one unit of the flow adds. A score that is not a weighted sum of indicators has no split: refused. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
collection | path | yes | string | Method collection name the scoring set is configured on (from list_scoring_sets) |
scoringSet | path | yes | string | - |
score | path | yes | string | Name of one score of that scoring set (from list_scoring_sets) |
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 `scoringSet` or `score` not found | `dbName` or `processId` or `collection` or `scoringSet` or `score` not found |
GET /api/v1/db/{dbName}/activity/{processId}/contributing-activities/{collection}/score/{scoringSet}/{score}
Operation ID: get_score_contributing_activities
Summary: LCA / ACV: upstream activities weighing most in one score of a scoring set (list_scoring_sets): 'which suppliers drive my single score?'.
LCA / ACV: upstream activities weighing most in one score of a scoring set (list_scoring_sets): 'which suppliers drive my single score?'. Contribution = weighted sum over indicators, so activities add up to score_activity's score. A score that is not a weighted sum of indicators has no split: refused. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
processId | path | yes | string | - |
collection | path | yes | string | Method collection name the scoring set is configured on (from list_scoring_sets) |
scoringSet | path | yes | string | - |
score | path | yes | string | Name of one score of that scoring set (from list_scoring_sets) |
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 `scoringSet` or `score` not found | `dbName` or `processId` or `collection` or `scoringSet` or `score` 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 | - |
role | query | no | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ActivitySummary[] | - |
400 | Invalid `role` | Invalid `role` |
404 | `dbName` or `flowId` not found | `dbName` or `flowId` not found |
GET /api/v1/db/{dbName}/flow/{flowId}/factors
Operation ID: get_flow_factors
Summary: LCA / ACV: which impact categories count one elementary flow, with what factor, in every loaded collection (or one): 'does this emission count anywhere?' in one call; explain_cf answers one method at a time.
LCA / ACV: which impact categories count one elementary flow, with what factor, in every loaded collection (or one): 'does this emission count anywhere?' in one call; explain_cf answers one method at a time. Per collection, 'factors' lists methods with something to say, shaped as explain_cf answers (relay 'explanation'). 'outcome': characterized, conversion_refused (factor unusable: scores nothing), or no_factor with 'regionalFactorCount' > 0: charged by the emitting activity's location, so it counts though no single factor answers. 'noFactor': methods giving no factor anywhere. All 'factors' empty: the flow adds nothing to any score, whatever its amount. Show each 'web_url' as a clickable link: it opens the VoLCA page.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
flowId | path | yes | string | - |
collection | query | no | string | Method collection name (from list_methods) to ask alone; every loaded collection when omitted |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: FlowFactorsResult | - |
400 | Invalid `collection` | Invalid `collection` |
404 | `dbName` or `flowId` not found | `dbName` or `flowId` not found |
GET /api/v1/methods
Operation ID: list_methods
Summary: LCA / ACV: loaded LCIA methods, one per impact category (climate change, acidification, eutrophication, land use, water scarcity…)..
LCA / ACV: loaded LCIA methods, one per impact category (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 | - |
collection | query | no | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodDetail | - |
400 | Invalid `collection` | Invalid `collection` |
404 | `methodId` not found | `methodId` not found |
GET /api/v1/method/{methodId}/factors
Parameters
| Name | In | Required | Type | Description |
|---|
methodId | path | yes | string | - |
collection | query | no | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodFactorAPI[] | - |
400 | Invalid `collection` | Invalid `collection` |
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 | - |
collection | query | no | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MappingStatus | - |
400 | Invalid `collection` | Invalid `collection` |
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: how a method's characterization factors map onto database flows, with match coverage..
LCA / ACV: how a method's characterization factors map onto database flows, with match coverage.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
methodId | path | yes | string | - |
collection | query | no | string | Method collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them. |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: FlowCFMapping | - |
400 | Invalid `collection` | Invalid `collection` |
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: a method's characterization factors matched to database flows.
LCA / ACV: a method's characterization factors matched to database flows. No 'flow': top factors by absolute value; with it, a name search. Gives CF value, direction, matched flow, 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) |
collection | query | no | string | Method collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them. |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: CharacterizationResult | - |
400 | Invalid `collection` or `limit` or `flow` | Invalid `collection` or `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: why one elementary flow scores with its characterization factor, and which method line applied.
LCA / ACV: why one elementary flow scores with its characterization factor, and which method line applied. Relay the 'explanation' sentences as written; do not decode the codes yourself. 'outcome': characterized, conversion_refused (factor found, unit does not convert: scores nothing) or no_factor. 'match.rung', how the factor was found: flow_id (flow named by the method), same_unit_name (line in the flow's unit), exact_name (name and compartment), compartment_default (the compartment's line), if_absent (subcompartment without line, sent to another by the compartment table), resource_unspecified (resource read at its name's unspecified line), cas_number (same CAS), region_base_name (base substance, region suffix untagged by the method), energy_content (charge per energy, or the carrier family's factor over its energy content, applied to the content the name states), ore_base_element (graded ore's base element). 'steps_tried': rungs tried before. 'match.unitConversion': same_unit, unknown_unit (unit not in the table, amount kept), unit_converted, normalized_to_base_unit (factor written as 'kg CO2 eq'-like expression, amount brought to base unit), energy_content (across dimensions by energy density). 'match.refusal': different_dimensions, no_base_unit, energy_bridge_failed. Show each 'web_url' as a clickable link: it opens the VoLCA page.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
methodId | path | yes | string | - |
flowId | path | yes | string | - |
collection | query | no | string | Method collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them. |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ExplainCFResult | - |
400 | Invalid `collection` | Invalid `collection` |
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 flows by name.
LCA / ACV: search flows by name. 'kind': biosphere (substance exchanged with nature: CO2, CH4, water, land occupation), technosphere (product one activity makes, another consumes) or waste. kind=biosphere keeps substances only, what factor and inventory questions want. Biosphere 'category' is the medium (air, water, soil, resource): resource taken vs emission released; other kinds have none.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
q | query | no | string | - |
lang | query | no | string | - |
kind | query | no | string | Keep only these kinds of flow: technosphere | biosphere | waste. Name several separated by commas, as in "biosphere,waste". Omit for all three. |
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 `kind` or `lang` or `q` | Invalid `order` or `sort` or `offset` or `limit` or `kind` or `lang` or `q` |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/search-counts
Operation ID: count_search_matches
Summary: LCA / ACV: how many processes, products and flows one query matches in a database, one call.
LCA / ACV: how many processes, products and flows one query matches in a database, one call. Disjoint, together the whole database: process = activity row (searched, read, scored), product = technosphere flow one activity makes and another consumes, flow = exchanged with nature or discarded. Tells what a query is about before listing: 2 processes and 300 flows is a substance, not a product.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
q | query | no | string | - |
sort | query | no | string | - |
exact | query | no | boolean | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: SearchCountsAPI | - |
400 | Invalid `exact` or `sort` or `q` | Invalid `exact` or `sort` or `q` |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/activities
Operation ID: search_activities
Summary: LCA / ACV: search activities (processes) by name, geography, product, classification or preset.
LCA / ACV: search activities (processes) by name, geography, product, classification or preset. Ranked, paginated, best first, with process IDs. Activity and product names together must hold every word, or a close spelling. Entry point for any product or process question, any language: food (yaourt, steak, pain, lait, fromage), packaging (PET, verre, carton), matériaux, énergie, transport, empreinte carbone, empreinte environnementale, impact environnemental, occupation des sols, surface agricole, prairie, pâturage, intrants, filière, chaîne amont. Names are mostly English: translate into their language first (pomme de terre: potato, acier: steel). Nothing fits: try the database's own wording, or a broader word.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
name | query | no | string | Words in the language of the database's names (usually English), or the exact name with exact=true. A source file's dataset identifier (SimaPro 'Process identifier'), whole or its four or more distinguishing characters, puts that dataset's products first. |
geo | query | no | string | Location (e.g. 'FR', 'DE', 'GLO') and every location inside it ('US' matches 'US-WECC', 'RER' matches 'FR'), per the engine's location table, never the spelling: 'GL' does not match 'GLO'. |
product | query | no | string | Product name filter |
exact | query | no | boolean | True: the name equals (case aside) instead of containing, and geo is that location alone, not the ones inside it |
preset | query | no | string | Classification preset (list_presets), expanded to its filters; combines with explicit classification filters. |
classification | query | no | string[] | Classification system (e.g. 'ISIC rev.4 ecoinvent', 'CPC'; list_classifications). |
classification-value | query | no | string[] | - |
classification-mode | query | no | string[] | - |
process | query | no | string[] | Process IDs (activityUUID_productUUID) to list instead of searching, in the order given, through the geo, product, exact and classification filters; name and sort ignored. An ID not held is left out; a malformed one, or a bare activity UUID naming several processes, is refused. |
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 `process` 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 `process` 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: a database's classification systems.
LCA / ACV: a database's classification systems. No 'system': names and activity counts only. With it: all its values, 'filter' narrowing 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 |
GET /api/v1/db/{dbName}/catalogue
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
offset | query | no | integer | - |
limit | query | no | integer | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: CataloguePage | - |
400 | Invalid `limit` or `offset` | Invalid `limit` or `offset` |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/catalogue/fingerprint
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: CatalogueFingerprint | - |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/compare
Operation ID: compare_databases
Summary: LCA / ACV: compare two loaded databases, usually two versions: activities added, removed, changed (with compare_activities' detail).
LCA / ACV: compare two loaded databases, usually two versions: activities added, removed, changed (with compare_activities' detail). Pairing cascade, each rung on what earlier ones left: 'SameProcessId' (same activityUUID_productUUID), 'SameNames' (activity and product names, case, trailing ' {GEO}' and SimaPro's ' U'/' S' aside, same location), 'SameProduct' (same reference product flow, location and activity kind, so no market pairs a production), 'SameCutNames' (names over 80 characters cut with their geography, as SimaPro does). Changed activities name their rung. A key several activities share, either side, pairs none: 'ambiguous', not compared. Only stated dates differ: 'redated'; same content: 'unchanged', with rung; the three lists are all pairs. 'database' is the base, usually older. Counts cover full lists, limit truncates each: pass one in a conversation (thousands differ, 'unchanged' holds nearly all).
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
other_database | query | no | string | Loaded database to compare against, usually the newer version |
limit | query | no | integer | Max entries per list (added, removed, changed, redated, ambiguous, unchanged), in name order (default: all). The counts always cover the full lists. |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: DatabaseComparison | - |
400 | Invalid `limit` or `other_database` | Invalid `limit` or `other_database` |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/score-pairs
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
other_database | query | no | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ScorePairs | - |
400 | Invalid `other_database` | Invalid `other_database` |
404 | `dbName` not found | `dbName` not found |
POST /api/v1/db/{dbName}/score-units
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ScoreUnitsRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ScoreUnits | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
POST /api/v1/db/{dbName}/impacts/{collection}
Operation ID: score_activities
Summary: LCA / ACV: rank N activities on one scoring set, one call.
LCA / ACV: rank N activities on one scoring set, one call. Columnar JSON {scoring_set, scoring_unit, functional_unit?, columns, rows, not_found, invalid, unscorable, unsolvable, cutoff_notice?, cutoff_inputs_by_process_id?, withheld_cutoffs_by_process_id?}. 'columns' heads 'rows' (one scalar array per activity): ['name', 'process_id', 'web_url', 'total', 'cutoffs', <indicator keys...>]; 'cutoffs' counts the row's chain inputs no loaded database supplies (scored zero, listed in 'cutoff_inputs_by_process_id'). 'functional_unit' top-level when all rows share it, else a column. No per-method scores: score_activity gives them. Unresolved IDs: not_found / invalid; refused allocation: unscorable; no solver answer (a loop consuming all it makes): unsolvable; one line per reason with its process_ids, the rest still ranked. 'basis' once for all (see score_activity); a row's parameter set is a position in 'parameterSets'. Set that weighs (list_scoring_sets): quote 'reading_notice' with any comparison. Collection with several sets: pass scoring_sets: ["<one>"]. 'parameter_sets': each activity scored at each set, 'parameter_set' column after 'process_id'. Show each 'web_url' as a clickable link: it opens the VoLCA page.
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 |
POST /api/v1/db/{dbName}/impacts/{collection}/{methodId}
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
collection | path | yes | string | - |
methodId | path | yes | string | - |
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` or `methodId` not found | `dbName` or `collection` or `methodId` not found |
GET /api/v1/db
Operation ID: list_databases
Summary: LCA / ACV: list loaded LCA databases (Agribalyse, ecoinvent…).
LCA / ACV: list loaded LCA databases (Agribalyse, ecoinvent…). Call first, 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, its declared dependencies first (cross-database links).
LCA / ACV: load a configured database into memory, its declared dependencies first (cross-database links). Search, score and impact tools need it loaded; list_databases names the configured ones. No effect if 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 to free memory; files stay, load_database reloads it.
LCA / ACV: unload a database to free memory; files stay, load_database reloads it. Refused while a loaded database depends on it: unload those 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 gaps of a database: input demands still unsupplied after internal resolution and cross-database linking, per (product, supplier activity named, location, unit), ranked by demanding edges.
LCA / ACV: supplier gaps of a database: input demands still unsupplied after internal resolution and cross-database linking, per (product, supplier activity named, location, unit), ranked by demanding edges. Each gap: every blocking reason, consumer edge and distinct consumer counts, total demand, top consumers. 'What is missing to switch or complete this database's background?', typically after a relink.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
limit | query | no | integer | Max gaps, biggest first (default all); header counts cover the full report. |
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: soundness report of a database, staged or loaded, for those who build or repair one: structural defects a score cannot show.
LCA / ACV: soundness report of a database, staged or loaded, for those who build or repair one: structural defects a score cannot show. Checks: reference exchange not exactly one; allocation shares not summing to 100%, on some coproducts only, or outside 0-100%; outright duplicates (name, location, reference product); non-finite amounts, zero reference amount; missing metadata (description, classification, location, unit unknown to the registry); undeclared geography, read off the name (SimaPro writes 'Unspecified' in whole databases) or filled by the loader; amounts disagreeing with their formulas, unevaluable formulas (mathematicalRelation); names merging under SimaPro's 80-character cut; exchanges missing the pedigree their database carries; reference products nothing consumes (expected for final products); unbalanced land transformation 'to'/'from' areas; impossible oxygen-demand or organic-carbon order (BOD5 > COD, dissolved > total organic carbon); failing CAS check digit. Finding: severity (danger, warning, info), activity, detail. get_gap_report answers 'what is missing?'.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
limit | query | no | integer | Max findings per check, worst first (default all); offenderCount covers the full list. |
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}/quality-report.csv
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
limit | query | no | integer | - |
Responses
| Status | Schema | Description |
|---|
200 | text/csv;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 of a LOADED database, judged against the catalogue's own norms.
LCA / ACV: computed checks of a LOADED database, judged against the catalogue's own norms. Scores every (activity, product) entry with one collection (the only loaded one, or 'collection'): per-category outliers on a log scale by median/MAD within (category, reference unit) groups (a mg-read-as-kg slip lands three orders out); entries scoring zero everywhere (empty or uncharacterized inventory); negative scores (info: fine where avoided-production credits or waste treatment dominate). get_quality_report checks what is STORED, staged databases too; this needs matrices and a loaded collection. Same finding shape.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
collection | query | no | string | Method collection to score with; required when several are loaded. |
limit | query | no | integer | Max findings per check, worst first (default all); offenderCount covers the full list. |
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}/computed-quality-report.csv
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
collection | query | no | string | - |
limit | query | no | integer | - |
Responses
| Status | Schema | Description |
|---|
200 | text/csv;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 of a database against loaded collections, for maintainers.
LCA / ACV: characterization coverage of a database against loaded collections, for maintainers. Lists flows a method scores ONLY through a name bridge (synonym or CAS): VoLCA scores them, a tool matching factors by exact name scores them zero, silently. Grouped under the method's own name (rename target). One entry per collection, so two versions compare side by side; optionally one collection.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
collection | query | no | string | One loaded method collection (list_methods); every one when omitted. |
limit | query | no | integer | Max bridge groups per collection (default all); bridgeGroupCount covers the full list. |
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 |
POST /api/v1/db/{dbName}/derive/{newName}
Operation ID: derive_database
Summary: LCA / ACV: make a parent or child of a database under a new name.
LCA / ACV: make a parent or child of a database under a new name. Parent (parent=true): source files reread, each multi-product block kept whole, declared shares turned into prices. Child (system_model): a parent divided by a system model, TOML text naming the default property (price, dry mass, wet mass) and exceptions, each with property, reason, and processes taken by classification or activity id. Shows a study with multi-output blocks divided by a product property, not the source's shares. Source untouched; all databases usable side by side. Full load, not a copy: seconds to minutes when large. Refused: neither or both given, child of a non-parent, model that does not read, exception taking or dividing nothing, read-only instance.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
newName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | DeriveRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: LoadDatabaseResponse | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` or `newName` not found | `dbName` or `newName` not found |
GET /api/v1/db/{dbName}/system-model
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: SystemModelAPI | - |
404 | `dbName` not found | `dbName` not found |
DELETE /api/v1/db/{dbName}
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ActivateResponse | - |
404 | `dbName` not found | `dbName` not found |
POST /api/v1/db/{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, or its name, location, description, keeping the activity: the tool that writes data.
LCA / ACV: change what one activity consumes and emits, or its name, location, description, keeping the activity: the tool that writes data. Adapts an imported dataset to the study: drop an out-of-scope substance, fix an amount, add a missing supplier, fix name or location, give a line a formula, set or remove an activity parameter. Unnamed parts stay (classification, synonyms, pedigree, coproducts). Inventory side only: input by provider process_id, waste output by treatment process_id, biosphere line by flow id (get_activity); reference product and coproducts unreachable (they make the activity what it is). Selector matching nothing: refused; matching several lines: all edited, count given. Formulas in the engine's language (get_formula_language; check_formula tries one). After all changes, a line whose formula no longer gives its amount takes the formula's value, listed under restated. Refused on databases read from the engine's configuration (shared background): copy first. 'transient': in memory only, 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}/activities/exchanges
Operation ID: edit_activities
Summary: edit_exchanges on several activities as one change: all edits judged first, all refused if one is; database rebuilt and relinked once (most of an edit's cost when large).
edit_exchanges on several activities as one change: all edits judged first, all refused if one is; database rebuilt and relinked once (most of an edit's cost when large). Each element of edits: {process_id} plus edit_exchanges' arguments, no note (one note for the change). Each activity once per request, two products of one activity included. Answer: each activity's report in request order, then transient and warnings once.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ActivitiesEditRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ActivitiesEditResponse | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
POST /api/v1/db/{dbName}/missing-suppliers/supply
Operation ID: supply_missing_product
Summary: Give a missing product a supplier for every activity lacking it: each unanswered input asking for this product (and naming supplier_activity, if given) moves to the provider, keeping amount, formula, comment, as edit_activities' set_suppliers would.
Give a missing product a supplier for every activity lacking it: each unanswered input asking for this product (and naming supplier_activity, if given) moves to the provider, keeping amount, formula, comment, as edit_activities' set_suppliers would. Product and supplier activity: name and supplier_activity of a get_gap_report gap. Provider: a process_id here or in a dependency, making the product in a unit the lines convert from; one line it cannot supply refuses the whole change. Answers as edit_activities.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | SupplyMissingRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ActivitiesEditResponse | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` 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 | DatabaseExportRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/octet-stream: OctetStream | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/files/{path}
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
path | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/octet-stream: OctetStream | - |
404 | `dbName` or `path` not found | `dbName` or `path` not found |
PUT /api/v1/db/{dbName}/licence
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | Licence |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: Licence | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
PUT /api/v1/db/{dbName}/release
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | Release |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: Release | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
PUT /api/v1/db/{dbName}/display-name
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | string |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: string | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
PUT /api/v1/db/{dbName}/description
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | string |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: string | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
POST /api/v1/db/{dbName}/accept-substitution
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ReleaseSubstitution |
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/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 | - |
GET /api/v1/method-collections/available
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: AvailableMethodCollection[] | - |
POST /api/v1/method-collections/available/{name}/install
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}/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 | - |
flows_from | 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 `flows_from` or `description` or `name` | Invalid `body` or `flows_from` 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/method-collections/{collection}/compare
Operation ID: compare_method_collections
Summary: LCA / ACV: compare two loaded method collections, usually two versions or ports of a method: per category pair, factors added, removed, changed (both values and ratio).
LCA / ACV: compare two loaded method collections, usually two versions or ports of a method: per category pair, factors added, removed, changed (both values and ratio). Categories pair on 'pairs', then 'SameMethodName', then 'SameImpactCategory', case and spacing aside; a name several share is 'ambiguous', settled by 'base=other' in 'pairs'. Factors pair per direction, compartment and location in a cascade: 'SameFlowId', 'SameName', 'SameSynonymClass', 'SameCAS' (refused when the registry keeps the names apart), 'SamePattern' for pattern and exclusion rows. Compartment-table fallbacks not followed: a precise subcompartment never equals unspecified; 'unspecified' is the whole medium. A factor without location whose name ends in a geography code ('Ammonia, FR') is read there. 'Occupation, ...' / 'Transformation, ...' under the whole natural-resource medium read in the land subcompartment, every land factor as input. 'reading': how both values were read per unit; equal within relative 1e-9. 'collection' is the base. Counts cover full lists, limit truncates each list of each category: pass one in a conversation.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Base method collection, usually the older version |
other_collection | query | no | string | Loaded method collection to compare against |
pairs | query | no | string[] | Categories to pair by hand, each written "base=other" with the two category names; taken before any other pairing |
category | query | no | string | Compare only the pair whose base category has this name, which is much faster than comparing them all; the unpaired and ambiguous categories are still listed |
limit | query | no | integer | Max entries per list of each category (added, removed, changed, ambiguous, unconvertible), in order (default: all). The counts always cover the full lists. |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodCollectionComparison | - |
400 | Invalid `limit` or `category` or `pairs` or `other_collection` | Invalid `limit` or `category` or `pairs` or `other_collection` |
404 | `collection` not found | `collection` not found |
GET /api/v1/method-collections/{collection}/profile
Operation ID: profile_method_collection
Summary: LCA / ACV: what each category of a loaded collection holds, without listing factors: factors per medium ('media', none for unfiled), how many written for one location and over how many locations, how many carry it at the end of the name ('Ammonia, FR'), how many zero, how many pattern or exclusion rows, and duplicates (one key, one place: a comparison cannot pair them).
LCA / ACV: what each category of a loaded collection holds, without listing factors: factors per medium ('media', none for unfiled), how many written for one location and over how many locations, how many carry it at the end of the name ('Ammonia, FR'), how many zero, how many pattern or exclusion rows, and duplicates (one key, one place: a comparison cannot pair them). Compartments and locations read as compare_method_collections does.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Loaded method collection to profile |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodCollectionProfile | - |
404 | `collection` not found | `collection` not found |
POST /api/v1/method-collections/{collection}/copy/{newName}
Operation ID: copy_method_collection
Summary: LCA / ACV: copy a method collection under a new name, to change it.
LCA / ACV: copy a method collection under a new name, to change it. Declared and built-in collections never change in place: their copies do. The copy scores as its source until changed, loaded at once, reads the source's files (source undeletable meanwhile). Named by the slug of 'new_name' (lower case, dashes), given in the response; a taken name is refused.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Method collection to copy |
newName | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodCollectionStatusAPI | - |
404 | `collection` or `newName` not found | `collection` or `newName` not found |
POST /api/v1/method-collections/{collection}/factors
Operation ID: edit_method_factors
Summary: LCA / ACV: in a loaded collection of one's own (copy or upload), change, remove or add one characterization factor, or rescale or set every factor a selector reaches.
LCA / ACV: in a loaded collection of one's own (copy or upload), change, remove or add one characterization factor, or rescale or set every factor a selector reaches. 'op': set / remove name a factor by method_id (list_methods), flow_id and location (get_characterization or the method's factors), 'value' (present value) choosing among several at that place; add names method_id and the whole factor; scale / set-all name a selector 'match'. Not exactly one factor: refused with candidates; two identical factors only by selector; a selector touching nothing: refused. Response: the journal line and factors touched. Declared collections refused: copy_method_collection first.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Loaded method collection of one's own: a copy or an upload |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | FactorEditRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodEditResponse | - |
400 | Invalid `body` | Invalid `body` |
404 | `collection` not found | `collection` not found |
POST /api/v1/method-collections/{collection}/categories
Operation ID: edit_method_categories
Summary: LCA / ACV: in a loaded collection of one's own (copy or upload), add, rename, re-unit or remove an impact category.
LCA / ACV: in a loaded collection of one's own (copy or upload), add, rename, re-unit or remove an impact category. 'op': add names 'name' and 'unit' (optional 'impact_category', 'methodology'), starting with no factor (edit_method_factors adds them); rename, set-unit, remove name 'method_id' (list_methods). A rename carries along scoring sets and unregionalized categories naming it. Refused: a name in use, removing a category a scoring set weighs (set named). Response: journal line and method_id.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Loaded method collection of one's own: a copy or an upload |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | CategoryEditRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodEditResponse | - |
400 | Invalid `body` | Invalid `body` |
404 | `collection` not found | `collection` not found |
GET /api/v1/method-collections/{collection}/scoring-sets
Operation ID: list_scoring_sets
Summary: LCA / ACV: formula-based scoring sets of loaded collections, each aggregating category scores into weighted or normalized 'score' values (e.g.
LCA / ACV: formula-based scoring sets of loaded collections, each aggregating category scores into weighted or normalized 'score' values (e.g. single score plus per-area-of-protection sub-scores). Per set: name, display unit, variables (each with its category), computed intermediates, display labels (variable → indicator name), normalization and weighting factors, score formulas; the same set as 'rows' (label, categories with coefficient or formula, normalization, weight) with 'sum_of_rows', scores adding up the rows, which a new row joins. 'weighs': scores rest on value choices (a category weighed or counted otherwise than once, or normalized categories added), which ISO 14044 forbids in a comparison disclosed to the public. Set names key score_activity / score_activities answers; edit_scoring_sets changes rows by variable.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Method collection name. If omitted, returns scoring sets across all loaded collections, grouped by collection. |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ScoringSetAPI[] | - |
404 | `collection` not found | `collection` not found |
POST /api/v1/method-collections/{collection}/scoring-sets
Operation ID: edit_scoring_sets
Summary: LCA / ACV: change scoring sets of a loaded collection of one's own (copy or upload), each named by 'set'.
LCA / ACV: change scoring sets of a loaded collection of one's own (copy or upload), each named by 'set'. 'op': create from 'rows' (optional 'unit'), remove, rename to 'name', set-unit to 'unit', set-multiplier to 'multiplier' (none drops it); add-row a 'row', change-row / remove-row the row of 'variable' (list_scoring_sets); set-formula of a computed 'variable'; set-score a 'score' to a 'formula', remove-score. Row: {label, terms: [{methodId, coefficient}], normalization, weight, unit}, categories by method_id (list_methods). A weighted row joins the score summing the rows; other scores left alone. Refused, in a sentence: formula naming nothing the set holds, cycle, zero normalization, removing a row a score reads otherwise. Response: journal line; undo_method_edit undoes it whole.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Loaded method collection of one's own: a copy or an upload |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ScoringEditRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodEditResponse | - |
400 | Invalid `body` | Invalid `body` |
404 | `collection` not found | `collection` not found |
POST /api/v1/method-collections/{collection}/undo
Operation ID: undo_method_edit
Summary: LCA / ACV: undo a change to a collection of one's own by writing its inverse as a new journal line.
LCA / ACV: undo a change to a collection of one's own by writing its inverse as a new journal line. No 'line': latest change in effect, so repeated calls walk back one at a time, never into what a copy took from its source's configuration. 'line': that line, whatever it is (an undo line: redone). Selectors undone by restoring replaced values; a factor a later line changed refuses that, named.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Loaded method collection of one's own |
line | query | no | integer | The journal line to undo (from get_method_history); the latest change in effect when absent |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodEditResponse | - |
400 | Invalid `line` | Invalid `line` |
404 | `collection` not found | `collection` not found |
GET /api/v1/method-collections/{collection}/history
Operation ID: get_method_history
Summary: LCA / ACV: a method collection's journal, one entry per change: line, when, what (category, factor, values before and after, selector and factors touched), whether it undoes another line, whether still in effect.
LCA / ACV: a method collection's journal, one entry per change: line, when, what (category, factor, values before and after, selector and factors touched), whether it undoes another line, whether still in effect. Declared collections: empty.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Method collection name |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodHistoryEntry[] | - |
404 | `collection` not found | `collection` not found |
GET /api/v1/method-collections/{collection}/flows
Operation ID: search_method_flows
Summary: LCA / ACV: flows a loaded collection characterizes, once per direction and compartment, whose name holds every word of 'q' (case aside), by name.
LCA / ACV: flows a loaded collection characterizes, once per direction and compartment, whose name holds every word of 'q' (case aside), by name. Gives flow_id and compartment for writing a new factor.
Parameters
| Name | In | Required | Type | Description |
|---|
collection | path | yes | string | Loaded method collection |
q | query | no | string | Words the flow name holds; every flow when absent |
limit | query | no | integer | Max flows to return, in name order (default: 50) |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: MethodFlowAPI[] | - |
400 | Invalid `limit` or `q` | Invalid `limit` or `q` |
404 | `collection` not found | `collection` 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/flow-synonyms/{name}/rows
Parameters
| Name | In | Required | Type | Description |
|---|
name | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: RefDataRowsResponse | - |
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/compartment-mappings/{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/{name}/rows
Parameters
| Name | In | Required | Type | Description |
|---|
name | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: RefDataRowsResponse | - |
404 | `name` not found | `name` not found |
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/units/{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/units/{name}/rows
Parameters
| Name | In | Required | Type | Description |
|---|
name | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: RefDataRowsResponse | - |
404 | `name` not found | `name` not found |
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` |
GET /api/v1/usage
Parameters
| Name | In | Required | Type | Description |
|---|
after | query | no | integer | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: UsagePage | - |
400 | Invalid `after` | Invalid `after` |
DELETE /api/v1/usage
Parameters
| Name | In | Required | Type | Description |
|---|
boot | query | yes | string | - |
through | query | yes | integer | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: - | - |
400 | Invalid `through` or `boot` | Invalid `through` or `boot` |
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: this instance's classification filter presets: each a label over (system, value, mode) filters, for search_activities' classification parameters..
LCA / ACV: this instance's classification filter presets: each a label over (system, value, mode) filters, for search_activities' classification parameters.
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ClassificationPresetInfo[] | - |
GET /api/v1/licences
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: Licence[] | - |
GET /api/v1/formula-language
Operation ID: get_formula_language
Summary: The formula language of parameters and exchanges: each function and operator with usage, meaning, worked example; operators by binding, loosest first; rules for numbers, names, arguments..
The formula language of parameters and exchanges: each function and operator with usage, meaning, worked example; operators by binding, loosest first; rules for numbers, names, arguments.
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: FormulaLanguage | - |
POST /api/v1/db/{dbName}/formula-check
Operation ID: check_formula
Summary: Check a formula where it would be written, at the database's values: among a process's parameters ('process_id'), on one of its lines ('exchange', position among exchanges), or among database parameters if no process.
Check a formula where it would be written, at the database's values: among a process's parameters ('process_id'), on one of its lines ('exchange', position among exchanges), or among database parameters if no process. Answers value and names read, or the problem: name without value, cycle, formula that does not read. On a line, one parameter (or a number times one) whose unit does not convert to the line's is warned; products and quotients of units are not judged.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | FormulaCheckRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: FormulaCheckResponse | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/history
Operation ID: get_database_history
Summary: Every change to a database of one's own, oldest first: when; what, in words (activities added, rewritten, deleted; exchanges edited, amounts before and after; parameters changed); author's reason, if any; the 'database' it was made on.
Every change to a database of one's own, oldest first: when; what, in words (activities added, rewritten, deleted; exchanges edited, amounts before and after; parameters changed); author's reason, if any; the 'database' it was made on. A child lists its parent's changes first (its data carry them). Databases read from the engine's configuration have none.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: DatabaseHistoryEntry[] | - |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/parameters
Operation ID: get_database_parameters
Summary: A database's parameters, read by every process's formulas unless the process defines its own of that name: value (or formula and its value), unit, description, uncertainty.
A database's parameters, read by every process's formulas unless the process defines its own of that name: value (or formula and its value), unit, description, uncertainty. A process's own are in get_activity.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ParameterAPI[] | - |
404 | `dbName` not found | `dbName` not found |
POST /api/v1/db/{dbName}/parameters
Operation ID: edit_database_parameters
Summary: Set or remove a database's parameters, then restate every process reading them: a line whose formula no longer gives its amount takes the formula's value; the answer lists processes that moved.
Set or remove a database's parameters, then restate every process reading them: a line whose formula no longer gives its amount takes the formula's value; the answer lists processes that moved. Formulas in the engine's language (get_formula_language). Refused, saying why: name not one word of the language or a function's, second spelling of a parameter, non-finite value, formula that does not read, process left without value, removing a name a formula reads, moving an allocation share. Refused on databases read from the engine's configuration, as edit_exchanges.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ParametersEditRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ParametersEditResponse | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` not found | `dbName` not found |
GET /api/v1/db/{dbName}/scenarios
Operation ID: list_scenarios
Summary: A database's scenarios: name and parameter values, as {process?, name, value}.
A database's scenarios: name and parameter values, as {process?, name, value}. To score one, send its values as a scoring request's parameters. Marked shipped: come with the database (an openLCA package's parameter sets, named after their product system); others saved on it, which databases read from the configuration cannot hold. One an edit made unusable (parameter removed, say) carries the problem.
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ScenarioAPI[] | - |
404 | `dbName` not found | `dbName` not found |
PUT /api/v1/db/{dbName}/scenarios/{name}
Operation ID: save_scenario
Summary: Save parameter values on a database under a name, replacing what it held; the answer lists saved scenarios.
Save parameter values on a database under a name, replacing what it held; the answer lists saved scenarios. Each value {name, value}, plus process for a process's own. Refused, saying why: values a scoring request would refuse, a shipped scenario's name, a database read from the configuration (copy first).
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
name | path | yes | string | Name of the scenario |
Request body
| Media type | Schema |
|---|
application/json;charset=utf-8 | ScenarioSaveRequest |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ScenarioAPI[] | - |
400 | Invalid `body` | Invalid `body` |
404 | `dbName` or `name` not found | `dbName` or `name` not found |
DELETE /api/v1/db/{dbName}/scenarios/{name}
Operation ID: drop_scenario
Summary: Drop a scenario saved on a database; the answer lists those left.
Drop a scenario saved on a database; the answer lists those left. Refused for an unknown name and for shipped scenarios (back at every load).
Parameters
| Name | In | Required | Type | Description |
|---|
dbName | path | yes | string | - |
name | path | yes | string | Name of the scenario |
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: ScenarioAPI[] | - |
404 | `dbName` or `name` not found | `dbName` or `name` not found |
GET /api/v1/openapi.json
Responses
| Status | Schema | Description |
|---|
200 | application/json;charset=utf-8: JsonValue | - |
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 | - |
databaseParameters | yes | ParameterAPI[] | - |
dates | yes | DatasetDates | - |
description | yes | string[] | - |
documentation | yes | DocSection[] | - |
exchanges | yes | ExchangeWithUnit[] | - |
location | yes | string | - |
nativeId | no | string | - |
nativeType | no | NativeActivityType | - |
parameters | yes | ParameterAPI[] | - |
processId | yes | string | - |
productAmount | no | number | - |
productName | no | string | - |
productUnit | no | string | - |
synonyms | yes | object | - |
unit | yes | string | - |
withheld | no | WithheldExchanges | - |
DocSection
Type: object
| Property | Required | Type | Description |
|---|
label | yes | string | - |
text | yes | string | - |
DatasetDates
Type: object
| Property | Required | Type | Description |
|---|
created | no | Day | - |
lastRevised | no | Day | - |
stated | no | Day | - |
ActivitySummary
Type: object
| Property | Required | Type | Description |
|---|
activityName | yes | string | - |
allocationBy | no | string | - |
allocationFormula | no | string | - |
allocationPercent | no | number | - |
block | yes | string | - |
blockProducts | yes | integer | - |
location | yes | string | - |
massAllocationPercent | no | number | - |
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 | - |
position | yes | integer | - |
selector | no | ExchangeSelectorAPI | - |
targetActivityName | no | string | - |
targetLocation | no | string | - |
targetProcessId | no | string | - |
unitName | yes | string | - |
wasteRole | no | WasteRole | - |
Exchange
Type: oneOf(object | object | object)
TechRole
Type: string
Allowed values: ReferenceProduct, Coproduct, AvoidedProduct, ReferenceInput, Input
SupplierClaim
Type: oneOf(object | object | object | object | object)
Pedigree
Type: object
| Property | Required | Type | Description |
|---|
completeness | yes | integer | - |
geographical | yes | integer | - |
reliability | yes | integer | - |
technological | yes | integer | - |
temporal | yes | integer | - |
DeclaredShare
Type: object
| Property | Required | Type | Description |
|---|
by | no | string | - |
formula | no | string | - |
percent | yes | number | - |
ExchangeProperties
Type: object
| Property | Required | Type | Description |
|---|
dryMass | no | StatedAmount | - |
price | no | Price | - |
wetMass | no | StatedAmount | - |
StatedAmount
Type: object
| Property | Required | Type | Description |
|---|
amount | yes | number | - |
unit | yes | string | - |
Price
Type: object
| Property | Required | Type | Description |
|---|
amount | yes | number | - |
origin | yes | string | Allowed values: stated, deduced from share |
unit | no | string | - |
ExchangeFormula
Type: object
| Property | Required | Type | Description |
|---|
name | no | string | - |
text | yes | string | - |
BioDirection
Type: string
Allowed values: Resource, Emission
Compartment
Type: object
| Property | Required | Type | Description |
|---|
name | yes | Medium | - |
sub | no | string | - |
Medium
Type: string
Allowed values: Air, Water, Soil, NaturalResource, InventoryIndicator, Economic, Waste, Social, Immaterial
WasteRole
Type: string
Allowed values: TreatsWaste, SentToTreatment, FinalWasteFlow, TreatmentNotLoaded
ExchangeSelectorAPI
Type: object
| Property | Required | Type | Description |
|---|
flow | no | string | - |
kind | yes | string | - |
location | no | string | - |
provider | no | string | - |
WithheldExchanges
Type: object
| Property | Required | Type | Description |
|---|
lines | yes | ExchangeName[] | - |
reason | yes | string | - |
ExchangeName
Type: object
| Property | Required | Type | Description |
|---|
compartment | no | Compartment | - |
flowName | yes | string | - |
isInput | yes | boolean | - |
kind | yes | ExchangeKind | - |
targetActivityName | no | string | - |
targetLocation | no | string | - |
targetProcessId | no | string | - |
unitName | yes | string | - |
ExchangeKind
Type: string
Allowed values: technosphere, biosphere, waste
ParameterAPI
Type: object
| Property | Required | Type | Description |
|---|
description | yes | string | - |
formula | no | string | - |
name | yes | string | - |
uncertainty | no | Uncertainty | - |
unit | no | string | - |
value | no | number | - |
Uncertainty
Type: object
| Property | Required | Type | Description |
|---|
distribution | yes | string | Allowed values: lognormal, normal, triangular, uniform |
geometricMean | no | number | - |
geometricSd | no | number | - |
maximum | no | number | - |
mean | no | number | - |
minimum | no | number | - |
mode | no | number | - |
sd | no | number | - |
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 | - |
ProcessDivisionAPI
Type: object
| Property | Required | Type | Description |
|---|
parentActivity | yes | string | - |
parentDatabase | yes | string | - |
parentName | yes | string | - |
parentProcessId | yes | string | - |
rule | yes | string | - |
share | no | number | - |
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, MissingNode, 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 |
|---|
cutoffInputs | yes | CutoffInput[] | - |
flows | yes | InventoryFlowDetail[] | - |
metadata | yes | InventoryMetadata | - |
statistics | yes | InventoryStatistics | - |
withheldCutoffs | yes | WithheldCutoffs[] | - |
InventoryMetadata
Type: object
| Property | Required | Type | Description |
|---|
emissionFlows | yes | integer | - |
matchedFlows | 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 | - |
CutoffInput
Type: object
| Property | Required | Type | Description |
|---|
amount | yes | number | - |
consumers | yes | integer | - |
database | yes | string | - |
location | yes | string | - |
product | yes | string | - |
reasons | yes | BlockerReason[] | - |
supplier | no | string | - |
unit | yes | string | - |
BlockerReason
Type: object
| Property | Required | Type | Description |
|---|
detail | no | string | - |
reason | yes | string | - |
WithheldCutoffs
Type: object
| Property | Required | Type | Description |
|---|
count | yes | integer | - |
database | yes | string | - |
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 |
|---|
cutoffInputs | yes | CutoffInput[] | - |
edges | yes | SupplyChainEdge[] | - |
filteredActivities | yes | integer | - |
root | yes | ActivitySummary | - |
supplyChain | yes | SupplyChainEntry[] | - |
totalActivities | yes | integer | - |
withheldCutoffs | yes | WithheldCutoffs[] | - |
withheldDatabases | yes | WithheldProcesses[] | - |
withheldInputs | yes | WithheldInput[] | - |
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 | - |
WithheldProcesses
Type: object
| Property | Required | Type | Description |
|---|
database | yes | string | - |
processes | yes | integer | - |
reason | yes | string | - |
WithheldInput
Type: object
| Property | Required | Type | Description |
|---|
consumer | yes | string | - |
database | yes | string | - |
Aggregation
Type: object
| Property | Required | Type | Description |
|---|
cutoffInputs | yes | CutoffInput[] | - |
filteredCount | yes | integer | - |
filteredTotal | yes | number | - |
filteredUnit | no | string | - |
groups | yes | AggregationGroup[] | - |
scope | yes | string | - |
withheldCutoffs | yes | WithheldCutoffs[] | - |
withheldDatabases | yes | WithheldProcesses[] | - |
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[] | - |
basis | no | ScoreBasis | - |
cutoffInputs | yes | CutoffInput[] | - |
cutoffWaste | yes | CutoffWasteFlow[] | - |
normWeightSetName | no | string | - |
results | yes | LCIAResult[] | - |
scoringIndicators | yes | object | - |
scoringResults | yes | object | - |
scoringRows | yes | object | - |
scoringUnits | yes | object | - |
singleScore | no | number | - |
singleScoreUnit | no | string | - |
withheld | yes | string[] | - |
withheldCutoffs | yes | WithheldCutoffs[] | - |
LCIAResult
Type: object
| Property | Required | Type | Description |
|---|
basis | no | ScoreBasis | - |
category | yes | string | - |
cutoffInputs | yes | CutoffInput[] | - |
damageCategory | yes | string | - |
exchangeContributions | yes | ExchangeContribution[] | - |
functionalUnit | yes | string | - |
mappedFlows | yes | integer | - |
methodId | yes | UUID | - |
methodName | yes | string | - |
normalizedScore | no | number | - |
probableMisses | no | ProbableMisses | - |
score | yes | number | - |
topContributors | yes | FlowContributionEntry[] | - |
unit | yes | string | - |
weightedScore | no | number | - |
withheld | no | string | - |
withheldCutoffs | yes | WithheldCutoffs[] | - |
withheldDatabases | yes | WithheldShare[] | - |
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 | - |
WithheldShare
Type: object
| Property | Required | Type | Description |
|---|
contribution | yes | number | - |
database | yes | string | - |
reason | yes | string | - |
sharePct | yes | number | - |
ExchangeContribution
Type: object
| Property | Required | Type | Description |
|---|
contribution | yes | number | - |
position | yes | integer | - |
sharePct | yes | number | - |
ProbableMisses
Type: object
| Property | Required | Type | Description |
|---|
more | yes | integer | - |
shown | yes | ProbableMissEntry[] | - |
withheld | yes | string[] | - |
ProbableMissEntry
Type: object
| Property | Required | Type | Description |
|---|
category | yes | string | - |
compartment | no | string | - |
factor | yes | number | - |
flowId | yes | string | - |
flowName | yes | string | - |
quantity | yes | number | - |
unit | yes | string | - |
upTo | yes | number | - |
upToSharePct | yes | number | - |
writtenAt | yes | string[] | - |
ScoreBasis
Type: object
| Property | Required | Type | Description |
|---|
databases | yes | BasisDatabase[] | - |
engine | yes | string | - |
methods | yes | BasisMethods | - |
parameterSets | yes | ParameterValue[][] | - |
substitutions | yes | Substitution[] | - |
BasisDatabase
Type: object
| Property | Required | Type | Description |
|---|
edited | yes | boolean | - |
name | yes | string | - |
patched | yes | boolean | - |
readsFilesOf | no | string | - |
reallocated | yes | boolean | - |
release | no | Release | - |
Release
Type: object
| Property | Required | Type | Description |
|---|
name | yes | string | - |
systemModel | no | string | - |
version | yes | string | - |
BasisMethods
Type: object
| Property | Required | Type | Description |
|---|
collection | yes | string | - |
copyOf | no | string | - |
modified | yes | boolean | - |
Substitution
Type: object
| Property | Required | Type | Description |
|---|
consumer | no | string | - |
from | yes | string | - |
to | yes | string | - |
ParameterValue
Type: object
| Property | Required | Type | Description |
|---|
name | yes | string | - |
process | no | string | - |
value | 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 |
|---|
parameters | no | ParameterValue[] | - |
substitutions | no | Substitution[] | - |
SensitivityResponse
Type: object
| Property | Required | Type | Description |
|---|
baseline | yes | LCIAResult | - |
cutoffInputs | yes | CutoffInput[] | - |
perturbed | yes | PerturbedEntry[] | - |
withheldCutoffs | yes | WithheldCutoffs[] | - |
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[] | - |
ReducedModel
Type: object
| Property | Required | Type | Description |
|---|
baseline | yes | number[] | - |
excludeLongTerm | yes | boolean | - |
methods | yes | ReducedMethod[] | - |
parameters | yes | FreeParameter[] | - |
processes | yes | ModelProcess[] | - |
scoringSets | yes | ModelScoringSet[] | - |
suppliers | yes | ModelSupplier[] | - |
ReducedMethod
Type: object
| Property | Required | Type | Description |
|---|
id | yes | UUID | - |
name | yes | string | - |
unit | yes | string | - |
FreeParameter
Type: object
| Property | Required | Type | Description |
|---|
parameter | yes | ParameterAPI | - |
process | no | string | - |
ModelProcess
Type: object
| Property | Required | Type | Description |
|---|
bindings | yes | ModelBinding[] | - |
biosphere | yes | ModelEmission[] | - |
name | yes | string | - |
parameters | yes | object | - |
processId | yes | string | - |
reference | yes | ModelReference | - |
scaling | yes | number | - |
technosphere | yes | ModelInput[] | - |
values | yes | object | - |
ModelBinding
Type: object
| Property | Required | Type | Description |
|---|
formula | yes | Formula | - |
name | yes | string | - |
Formula
Type: object
A number, a name in lower case, or an array: a function or an operator, then its arguments.
ModelReference
Type: object
| Property | Required | Type | Description |
|---|
inputs | yes | ModelLine[] | - |
outputs | yes | ModelLine[] | - |
selfLoops | yes | ModelLine[] | - |
ModelLine
Type: object
| Property | Required | Type | Description |
|---|
formula | no | Formula | - |
stored | yes | number | - |
ModelInput
Type: object
| Property | Required | Type | Description |
|---|
factor | yes | number | - |
line | yes | ModelLine | - |
supplier | yes | integer | - |
ModelEmission
Type: object
| Property | Required | Type | Description |
|---|
factors | yes | number[] | - |
line | yes | ModelLine | - |
ModelSupplier
Type: object
| Property | Required | Type | Description |
|---|
database | yes | string | - |
processId | yes | string | - |
scalings | yes | number[] | - |
scores | yes | number[] | - |
ModelScoringSet
Type: object
| Property | Required | Type | Description |
|---|
computed | yes | ModelBinding[] | - |
displayMultiplier | yes | number | - |
name | yes | string | - |
normalization | yes | object | - |
scores | yes | object | - |
unit | yes | string | - |
variables | yes | object | - |
weighting | yes | object | - |
ReducedModelRequest
Type: object
| Property | Required | Type | Description |
|---|
parameters | yes | ParameterName[] | - |
ParameterName
Type: object
| Property | Required | Type | Description |
|---|
name | yes | string | - |
process | no | string | - |
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 | - |
ActivityComparison
Type: object
| Property | Required | Type | Description |
|---|
base | yes | ActivitySummary | - |
exchanges | yes | ExchangeChange[] | - |
other | yes | ActivitySummary | - |
summary | yes | SummaryChange[] | - |
uncompared | yes | UncomparedLine[] | - |
SummaryChange
Type: oneOf(object | object | object | object | object | object)
ExchangeChange
Type: object
| Property | Required | Type | Description |
|---|
change | yes | LineChange | - |
compartment | no | Compartment | - |
flowId | yes | UUID | - |
flowName | yes | string | - |
role | yes | LineRole | - |
LineRole
Type: oneOf(object | object | object)
WasteSide
Type: string
Allowed values: WasteInput, WasteOutput
LineChange
Type: oneOf(object | object | object | object)
Quantity
Type: object
| Property | Required | Type | Description |
|---|
amount | yes | number | - |
unit | yes | string | - |
LineMatch
Type: string
Allowed values: SameFlow, SameFlowName
Supplier
Type: object
| Property | Required | Type | Description |
|---|
activityName | yes | string | - |
location | yes | string | - |
UncomparedLine
Type: object
| Property | Required | Type | Description |
|---|
compartment | no | Compartment | - |
flowName | yes | string | - |
reason | yes | UncomparedReason | - |
role | yes | LineRole | - |
UncomparedReason
Type: oneOf(object | object)
ChangesPresence
Type: object
| Property | Required | Type | Description |
|---|
exchanges | yes | ChangePresence[] | - |
summary | yes | ChangePresence[] | - |
ChangePresence
Type: string
Allowed values: present, absent, different, line-gone
ChangesQuery
Type: object
| Property | Required | Type | Description |
|---|
exchanges | yes | ExchangeChange[] | - |
note | no | string | - |
source | no | Source | - |
summary | yes | SummaryChange[] | - |
Source
Type: object
| Property | Required | Type | Description |
|---|
document | yes | string | - |
page | no | integer | - |
passage | no | string | - |
ChangesApplied
Type: object
| Property | Required | Type | Description |
|---|
exchanges | yes | ChangeOutcome[] | - |
summary | yes | ChangeOutcome[] | - |
ChangeOutcome
Type: object
| Property | Required | Type | Description |
|---|
outcome | yes | string | Allowed values: applied, present, different, line-gone, not-applicable |
reason | no | string | - |
ContributingFlowsResult
Type: object
| Property | Required | Type | Description |
|---|
basis | yes | ScoreBasis | - |
cutoffInputs | yes | CutoffInput[] | - |
method | yes | string | - |
topFlows | yes | FlowContributionEntry[] | - |
totalScore | yes | number | - |
unit | yes | string | - |
withheldCutoffs | yes | WithheldCutoffs[] | - |
withheldDatabases | yes | WithheldShare[] | - |
ContributingActivitiesResult
Type: object
| Property | Required | Type | Description |
|---|
activities | yes | ActivityContribution[] | - |
basis | yes | ScoreBasis | - |
cutoffInputs | yes | CutoffInput[] | - |
method | yes | string | - |
totalScore | yes | number | - |
unit | yes | string | - |
withheldCutoffs | yes | WithheldCutoffs[] | - |
withheldDatabases | yes | WithheldShare[] | - |
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 | - |
FlowFactorsResult
Type: object
| Property | Required | Type | Description |
|---|
collections | yes | CollectionFactors[] | - |
flow | yes | ExplainedFlowAPI | - |
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 | - |
CollectionFactors
Type: object
| Property | Required | Type | Description |
|---|
collection | yes | string | - |
factors | yes | ExplainCFResult[] | - |
noFactor | yes | MethodSummary[] | - |
ExplainCFResult
Type: object
| Property | Required | Type | Description |
|---|
explanation | yes | string[] | - |
flow | yes | ExplainedFlowAPI | - |
match | no | ExplainedMatchAPI | - |
method | yes | string | - |
methodId | yes | UUID | - |
methodUnit | yes | string | - |
outcome | yes | string | - |
regionalFactorCount | yes | integer | - |
stepsTried | yes | ExplainedStepAPI[] | - |
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 | - |
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 | - |
reading | yes | FactorReading | - |
unit | no | string | - |
value | yes | number | - |
FactorReading
Type: object
| Property | Required | Type | Description |
|---|
location | no | ReadLocation | - |
medium | no | string | - |
ReadLocation
Type: object
| Property | Required | Type | Description |
|---|
code | yes | string | - |
from | yes | LocationSource | - |
LocationSource
Type: string
Allowed values: InField, InName
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 |
|---|
compartment | no | string | - |
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 | - |
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 | - |
kind | yes | ExchangeKind | - |
name | yes | string | - |
producerCount | no | integer | - |
synonyms | yes | object | - |
unitName | yes | string | - |
SearchCountsAPI
Type: object
| Property | Required | Type | Description |
|---|
flows | yes | integer | - |
processes | yes | integer | - |
products | yes | integer | - |
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[] | - |
CataloguePage
Type: object
| Property | Required | Type | Description |
|---|
entries | yes | CatalogueEntry[] | - |
fingerprint | yes | string | - |
offset | yes | integer | - |
total | yes | integer | - |
CatalogueEntry
Type: object
| Property | Required | Type | Description |
|---|
activityName | yes | string | - |
classification | yes | object | - |
location | yes | string | - |
measure | no | CatalogueMeasure | - |
processId | yes | string | - |
productAmount | no | number | - |
productName | yes | string | - |
unit | yes | string | - |
CatalogueMeasure
Type: object
| Property | Required | Type | Description |
|---|
dimension | yes | integer[] | - |
factor | yes | number | - |
CatalogueFingerprint
Type: object
| Property | Required | Type | Description |
|---|
fingerprint | yes | string | - |
DatabaseComparison
Type: object
| Property | Required | Type | Description |
|---|
added | yes | ActivitySummary[] | - |
addedCount | yes | integer | - |
ambiguous | yes | AmbiguousActivities[] | - |
ambiguousCount | yes | integer | - |
changed | yes | ChangedActivity[] | - |
changedCount | yes | integer | - |
redated | yes | ChangedActivity[] | - |
redatedCount | yes | integer | - |
removed | yes | ActivitySummary[] | - |
removedCount | yes | integer | - |
unchanged | yes | PairedActivities[] | - |
unchangedCount | yes | integer | - |
ChangedActivity
Type: object
| Property | Required | Type | Description |
|---|
comparison | yes | ActivityComparison | - |
match | yes | ActivityMatch | - |
ActivityMatch
Type: string
Allowed values: SameProcessId, SameNames, SameProduct, SameCutNames
AmbiguousActivities
Type: object
| Property | Required | Type | Description |
|---|
base | yes | ActivitySummary[] | - |
match | yes | ActivityMatch | - |
other | yes | ActivitySummary[] | - |
PairedActivities
Type: object
| Property | Required | Type | Description |
|---|
base | yes | ActivitySummary | - |
match | yes | ActivityMatch | - |
other | yes | ActivitySummary | - |
ScorePairs
Type: object
| Property | Required | Type | Description |
|---|
ambiguousCount | yes | integer | - |
pairs | yes | ScorePair[] | - |
setApart | yes | SetApartPair[] | - |
unpairedBaseCount | yes | integer | - |
unpairedOtherCount | yes | integer | - |
ScorePair
Type: object
| Property | Required | Type | Description |
|---|
activityName | yes | string | - |
base | yes | string | - |
location | yes | string | - |
match | yes | ActivityMatch | - |
other | yes | string | - |
perBaseUnit | yes | number | - |
SetApartPair
Type: object
| Property | Required | Type | Description |
|---|
activityName | yes | string | - |
base | yes | string | - |
location | yes | string | - |
other | yes | string | - |
reason | yes | PairRefusal | - |
PairRefusal
Type: oneOf(object | object | object | object | object | object)
ScoreUnits
Type: object
| Property | Required | Type | Description |
|---|
invalid | yes | string[] | - |
notFound | yes | string[] | - |
processes | yes | ScoreUnit[] | - |
reading | yes | ChosenUnit | - |
unit | yes | string | - |
ChosenUnit
Type: oneOf(object | object)
ScoreUnit
Type: object
| Property | Required | Type | Description |
|---|
activityName | yes | string | - |
location | yes | string | - |
processId | yes | string | - |
productUnit | no | string | - |
scale | yes | UnitScale | - |
UnitScale
Type: oneOf(object | object)
ScoreUnitsRequest
Type: object
| Property | Required | Type | Description |
|---|
processIds | yes | string[] | - |
unit | yes | string | - |
BatchImpactsResponse
Type: object
| Property | Required | Type | Description |
|---|
basis | yes | ScoreBasis | - |
invalid | yes | string[] | - |
notFound | yes | string[] | - |
readingNotice | no | string | - |
results | yes | BatchImpactsEntry[] | - |
unscorable | yes | string[] | - |
unsolvable | yes | UnsolvableEntry[] | - |
BatchImpactsEntry
Type: object
| Property | Required | Type | Description |
|---|
activityName | yes | string | - |
impacts | yes | LCIABatchResult | - |
parameterSet | no | integer | - |
processId | yes | string | - |
productAmount | no | number | - |
productUnit | no | string | - |
UnsolvableEntry
Type: object
| Property | Required | Type | Description |
|---|
parameterSet | no | integer | - |
processId | yes | string | - |
reason | yes | string | - |
BatchImpactsRequest
Type: object
| Property | Required | Type | Description |
|---|
parameterSets | no | ParameterValue[][] | - |
processIds | yes | string[] | - |
DatabaseListResponse
Type: object
| Property | Required | Type | Description |
|---|
databases | yes | DatabaseStatusAPI[] | - |
DatabaseStatusAPI
Type: object
| Property | Required | Type | Description |
|---|
activityCount | yes | integer | - |
added | no | string | - |
allocation | yes | string | - |
dependsOn | yes | string[] | - |
description | no | string | - |
displayName | yes | string | - |
format | no | string | - |
isUploaded | yes | boolean | - |
licence | yes | Licence | - |
loadAtStartup | yes | boolean | - |
modification | yes | Modification | - |
name | yes | string | - |
path | yes | string | - |
release | no | Release | - |
source | no | string | - |
status | yes | string | - |
systemModel | no | ModelTitle | - |
ModelTitle
Type: object
| Property | Required | Type | Description |
|---|
name | yes | string | - |
version | yes | string | - |
Licence
Type: object
| Property | Required | Type | Description |
|---|
accept | yes | boolean | - |
acceptance | no | string | - |
attribution | yes | boolean | - |
conditions | yes | string[] | - |
id | no | string | - |
kind | yes | LicenceKind | - |
name | no | string | - |
permissions | yes | PermissionState[] | - |
refused | yes | Permission[] | - |
text | no | string | - |
url | no | string | - |
usage | no | Disclosure | - |
LicenceKind
Type: string
Allowed values: unstated, standard, own
Permission
Type: string
Allowed values: inventory, scores, download, results, resell, paid-applications
PermissionState
Type: object
| Property | Required | Type | Description |
|---|
enforced | yes | boolean | - |
granted | yes | boolean | - |
permission | yes | Permission | - |
Disclosure
Type: string
Allowed values: anonymous, organizations
Modification
Type: object
| Property | Required | Type | Description |
|---|
edited | yes | boolean | - |
reallocated | yes | boolean | - |
LoadDatabaseResponse
Type: object
| Property | Required | Type | Description |
|---|
database | yes | DatabaseStatusAPI | - |
deps | yes | DepLoadResult[] | - |
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 | - |
reasons | yes | BlockerReason[] | - |
supplierActivity | no | 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 | - |
duplicateProducts | yes | QualityCheckAPI | - |
formulaConsistency | yes | QualityCheckAPI | - |
invalidCas | yes | QualityCheckAPI | - |
landTransformationBalance | yes | QualityCheckAPI | - |
missingMetadata | yes | QualityCheckAPI | - |
missingPedigree | yes | QualityCheckAPI | - |
obsoleteInputs | yes | QualityCheckAPI | - |
oxygenDemandOrder | yes | QualityCheckAPI | - |
processCount | yes | integer | - |
referenceProduct | yes | QualityCheckAPI | - |
suspiciousAmounts | yes | QualityCheckAPI | - |
truncatedNameCollisions | yes | QualityCheckAPI | - |
unallocated | yes | QualityCheckAPI | - |
unconsumedProducts | yes | QualityCheckAPI | - |
undeclaredGeography | yes | QualityCheckAPI | - |
unmeasurableAmounts | yes | QualityCheckAPI | - |
unsuppliedInputs | yes | QualityCheckAPI | - |
waterBalance | 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 | - |
unsolvable | 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 | - |
DeriveRequest
Type: object
| Property | Required | Type | Description |
|---|
parent | no | boolean | - |
systemModel | no | string | - |
SystemModelAPI
Type: object
| Property | Required | Type | Description |
|---|
exceptions | yes | ModelExceptionAPI[] | - |
parameters | yes | ModelParameterAPI[] | - |
substitutions | yes | ModelSubstitutionAPI[] | - |
text | yes | string | - |
ModelExceptionAPI
Type: object
| Property | Required | Type | Description |
|---|
key | yes | string | - |
processes | yes | TakenProcessAPI[] | - |
reason | yes | string | - |
TakenProcessAPI
Type: object
| Property | Required | Type | Description |
|---|
activity | yes | string | - |
name | yes | string | - |
ModelSubstitutionAPI
Type: object
| Property | Required | Type | Description |
|---|
block | yes | string | - |
coproduct | yes | string | - |
coproductName | yes | string | - |
ratio | yes | number | - |
reason | yes | string | - |
replacedProcess | yes | string | - |
replacedProduct | yes | string | - |
replaces | yes | string | - |
ModelParameterAPI
Type: object
| Property | Required | Type | Description |
|---|
name | yes | string | - |
processes | yes | TakenProcessAPI[] | - |
reason | yes | string | - |
value | yes | number | - |
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 | - |
note | no | string | - |
product | no | string | - |
source | no | Source | - |
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[] | - |
note | no | string | - |
source | no | Source | - |
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[] | - |
dryMassesSet | yes | integer[] | - |
formulasSet | yes | integer[] | - |
parametersRemoved | yes | string[] | - |
parametersSet | yes | string[] | - |
pricesSet | yes | integer[] | - |
removed | yes | integer[] | - |
restated | yes | RestatedLineAPI[] | - |
suppliersSet | yes | integer[] | - |
textsSet | yes | string[] | - |
transient | yes | boolean | - |
warnings | yes | string[] | - |
wetMassesSet | yes | integer[] | - |
RestatedLineAPI
Type: object
| Property | Required | Type | Description |
|---|
from | yes | number | - |
position | yes | integer | - |
to | yes | number | - |
ExchangeEditRequest
Type: object
| Property | Required | Type | Description |
|---|
addBiosphere | yes | BioExchangeAPI[] | - |
addInputs | yes | TechInputAPI[] | - |
addWasteOutputs | yes | WasteOutputAPI[] | - |
note | no | string | - |
remove | yes | ExchangeSelectorAPI[] | - |
removeParameters | yes | string[] | - |
setAmounts | yes | SetAmountAPI[] | - |
setDescription | no | string[] | - |
setDryMasses | yes | SetDryMassAPI[] | - |
setFormulas | yes | SetFormulaAPI[] | - |
setLocation | no | string | - |
setName | no | string | - |
setParameters | yes | SetParameterAPI[] | - |
setPrices | yes | SetPriceAPI[] | - |
setSuppliers | yes | SetSupplierAPI[] | - |
setWetMasses | yes | SetWetMassAPI[] | - |
source | no | Source | - |
SetAmountAPI
Type: object
| Property | Required | Type | Description |
|---|
amount | yes | number | - |
select | yes | ExchangeSelectorAPI | - |
SetParameterAPI
Type: object
| Property | Required | Type | Description |
|---|
description | no | string | - |
formula | no | string | - |
name | yes | string | - |
uncertainty | no | Uncertainty | - |
unit | no | string | - |
value | no | number | - |
SetFormulaAPI
Type: object
| Property | Required | Type | Description |
|---|
formula | no | string | - |
select | yes | ExchangeSelectorAPI | - |
SetPriceAPI
Type: object
| Property | Required | Type | Description |
|---|
price | no | StatedAmount | - |
product | yes | string | - |
SetDryMassAPI
Type: object
| Property | Required | Type | Description |
|---|
dryMass | no | StatedAmount | - |
product | yes | string | - |
SetWetMassAPI
Type: object
| Property | Required | Type | Description |
|---|
product | yes | string | - |
wetMass | no | StatedAmount | - |
SetSupplierAPI
Type: object
| Property | Required | Type | Description |
|---|
provider | yes | string | - |
select | yes | ExchangeSelectorAPI | - |
ActivitiesEditResponse
Type: object
| Property | Required | Type | Description |
|---|
edited | yes | ExchangeEditResponse[] | - |
transient | yes | boolean | - |
warnings | yes | string[] | - |
ActivitiesEditRequest
Type: object
| Property | Required | Type | Description |
|---|
edits | yes | ActivityEditAPI[] | - |
note | no | string | - |
source | no | Source | - |
ActivityEditAPI
Type: object
| Property | Required | Type | Description |
|---|
addBiosphere | yes | BioExchangeAPI[] | - |
addInputs | yes | TechInputAPI[] | - |
addWasteOutputs | yes | WasteOutputAPI[] | - |
processId | yes | string | - |
remove | yes | ExchangeSelectorAPI[] | - |
removeParameters | yes | string[] | - |
setAmounts | yes | SetAmountAPI[] | - |
setDescription | no | string[] | - |
setDryMasses | yes | SetDryMassAPI[] | - |
setFormulas | yes | SetFormulaAPI[] | - |
setLocation | no | string | - |
setName | no | string | - |
setParameters | yes | SetParameterAPI[] | - |
setPrices | yes | SetPriceAPI[] | - |
setSuppliers | yes | SetSupplierAPI[] | - |
setWetMasses | yes | SetWetMassAPI[] | - |
SupplyMissingRequest
Type: object
| Property | Required | Type | Description |
|---|
note | no | string | - |
product | yes | string | - |
provider | yes | string | - |
source | no | Source | - |
supplierActivity | no | string | - |
DatabaseExportRequest
Type: object
| Property | Required | Type | Description |
|---|
format | yes | string | - |
package | no | 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 | - |
documentation | yes | DatabaseDocumentation | - |
inputCount | yes | integer | - |
internalLinks | yes | integer | - |
isLoaded | yes | boolean | - |
isReady | yes | boolean | - |
licence | yes | Licence | - |
locationFallbacks | yes | LocationFallback[] | - |
locationUnresolved | yes | LocationUnresolved[] | - |
missingSuppliers | yes | MissingSupplier[] | - |
name | yes | string | - |
release | no | Release | - |
requiredReleases | yes | RequiredRelease[] | - |
supplierAmbiguities | yes | SupplierAmbiguity[] | - |
systemModels | yes | string[] | - |
unknownUnits | yes | string[] | - |
unresolvedLinks | yes | integer | - |
MissingSupplier
Type: object
| Property | Required | Type | Description |
|---|
count | yes | integer | - |
detail | no | string | - |
location | no | string | - |
locations | yes | string[] | - |
productName | yes | string | - |
reason | yes | string | - |
supplierActivity | no | 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 | - |
SupplierAmbiguity
Type: object
| Property | Required | Type | Description |
|---|
candidates | yes | integer | - |
chosen | 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 | - |
DatabaseDocumentation
Type: object
| Property | Required | Type | Description |
|---|
export | no | ExportStamp | - |
literature | yes | LibraryDocument[] | - |
systems | yes | LibraryDocument[] | - |
ExportStamp
Type: object
| Property | Required | Type | Description |
|---|
date | no | Day | - |
formatVersion | no | string | - |
project | no | string | - |
time | no | TimeOfDay | - |
tool | yes | string | - |
LibraryDocument
Type: object
| Property | Required | Type | Description |
|---|
category | yes | string | - |
files | yes | string[] | - |
name | yes | string | - |
sections | yes | DocSection[] | - |
RequiredRelease
Type: object
| Property | Required | Type | Description |
|---|
databases | yes | string[] | - |
release | yes | Release | - |
state | yes | Satisfaction | - |
Satisfaction
Type: string
Allowed values: satisfied, substituted, missing
ReleaseSubstitution
Type: object
| Property | Required | Type | Description |
|---|
database | yes | string | - |
release | yes | Release | - |
UploadResponse
Type: object
| Property | Required | Type | Description |
|---|
dropped | no | DroppedFactors | - |
families | yes | UploadedFamily[] | - |
format | no | string | - |
message | yes | string | - |
slug | no | string | - |
success | yes | boolean | - |
UploadedFamily
Type: object
| Property | Required | Type | Description |
|---|
factors | yes | integer | - |
name | yes | string | - |
slug | yes | string | - |
DroppedFactors
Type: object
| Property | Required | Type | Description |
|---|
count | yes | integer | - |
examples | yes | string[] | - |
MethodCollectionListResponse
Type: object
| Property | Required | Type | Description |
|---|
default | no | string | - |
methods | yes | MethodCollectionStatusAPI[] | - |
MethodCollectionStatusAPI
Type: object
| Property | Required | Type | Description |
|---|
added | no | string | - |
description | no | string | - |
displayName | yes | string | - |
format | no | string | - |
isUploaded | yes | boolean | - |
methodCount | yes | integer | - |
name | yes | string | - |
path | yes | string | - |
source | no | string | - |
status | yes | string | - |
AvailableMethodCollection
Type: object
| Property | Required | Type | Description |
|---|
description | yes | string | - |
installed | yes | boolean | - |
licence | no | string | - |
name | yes | string | - |
publisher | yes | string | - |
size | yes | integer | - |
sourceUrl | yes | string | - |
version | yes | string | - |
ExportRequest
Type: object
| Property | Required | Type | Description |
|---|
format | yes | string | - |
MethodCollectionComparison
Type: object
| Property | Required | Type | Description |
|---|
ambiguous | yes | AmbiguousCategories[] | - |
categories | yes | CategoryComparison[] | - |
unpairedBase | yes | CategorySide[] | - |
unpairedOther | yes | CategorySide[] | - |
CategoryComparison
Type: object
| Property | Required | Type | Description |
|---|
added | yes | FactorSide[] | - |
addedCount | yes | integer | - |
ambiguous | yes | AmbiguousFactors[] | - |
ambiguousCount | yes | integer | - |
base | yes | CategorySide | - |
changed | yes | ChangedFactor[] | - |
changedCount | yes | integer | - |
largestRatio | no | number | - |
match | yes | CategoryMatch | - |
other | yes | CategorySide | - |
removed | yes | FactorSide[] | - |
removedCount | yes | integer | - |
unchangedCount | yes | integer | - |
unconvertible | yes | UnconvertibleFactor[] | - |
unconvertibleCount | yes | integer | - |
CategoryMatch
Type: string
Allowed values: ForcedByCaller, SameMethodName, SameImpactCategory
CategorySide
Type: object
| Property | Required | Type | Description |
|---|
category | yes | string | - |
factorCount | yes | integer | - |
methodId | yes | UUID | - |
name | yes | string | - |
unit | yes | string | - |
FactorSide
Type: object
| Property | Required | Type | Description |
|---|
cas | no | string | - |
compartment | yes | string | - |
direction | yes | FlowDirection | - |
flowName | yes | string | - |
flowRef | yes | UUID | - |
location | no | string | - |
unit | no | string | - |
value | yes | number | - |
FlowDirection
Type: string
Allowed values: Input, Output
ChangedFactor
Type: object
| Property | Required | Type | Description |
|---|
base | yes | FactorSide | - |
match | yes | FactorMatch | - |
other | yes | FactorSide | - |
ratio | no | number | - |
reading | yes | ValueReading | - |
FactorMatch
Type: string
Allowed values: SameFlowId, SameName, SameSynonymClass, SameCAS, SamePattern
ValueReading
Type: string
Allowed values: UnitsIdentical, ConvertedOntoBaseUnit, ReadPerReferenceUnit, ComparedAsWritten
AmbiguousFactors
Type: object
| Property | Required | Type | Description |
|---|
base | yes | FactorSide[] | - |
match | yes | FactorMatch | - |
other | yes | FactorSide[] | - |
UnconvertibleFactor
Type: object
| Property | Required | Type | Description |
|---|
base | yes | FactorSide | - |
match | yes | FactorMatch | - |
other | yes | FactorSide | - |
AmbiguousCategories
Type: object
| Property | Required | Type | Description |
|---|
base | yes | CategorySide[] | - |
match | yes | CategoryMatch | - |
other | yes | CategorySide[] | - |
MethodCollectionProfile
Type: object
| Property | Required | Type | Description |
|---|
categories | yes | CategoryProfile[] | - |
CategoryProfile
Type: object
| Property | Required | Type | Description |
|---|
category | yes | CategorySide | - |
duplicates | yes | DuplicateFactors[] | - |
locatedCount | yes | integer | - |
locatedInNameCount | yes | integer | - |
locationCount | yes | integer | - |
media | yes | MediumCount[] | - |
patternCount | yes | integer | - |
zeroCount | yes | integer | - |
MediumCount
Type: object
| Property | Required | Type | Description |
|---|
factorCount | yes | integer | - |
medium | no | string | - |
DuplicateFactors
Type: object
| Property | Required | Type | Description |
|---|
factors | yes | FactorSide[] | - |
match | yes | FactorMatch | - |
MethodEditResponse
Type: object
| Property | Required | Type | Description |
|---|
after | no | number | - |
before | no | number | - |
line | yes | integer | - |
methodId | no | UUID | - |
touched | yes | integer | - |
FactorEditRequest
Type: object
| Property | Required | Type | Description |
|---|
factor | no | NewFactorAPI | - |
flowId | no | UUID | - |
location | no | string | - |
match | no | FactorMatchAPI | - |
methodId | no | UUID | - |
newValue | no | number | - |
op | yes | FactorEditOp | - |
scale | no | number | - |
value | no | number | - |
FactorEditOp
Type: string
Allowed values: set, remove, add, scale, set-all
FactorMatchAPI
Type: object
| Property | Required | Type | Description |
|---|
cas | no | string | - |
category | no | string | - |
flowName | no | string | - |
flowNamePrefix | no | string | - |
subcompartmentContains | no | string | - |
NewFactorAPI
Type: object
| Property | Required | Type | Description |
|---|
cas | no | string | - |
compartment | no | CompartmentAPI | - |
direction | yes | FlowDirection | - |
flowId | yes | UUID | - |
location | no | string | - |
name | yes | string | - |
unit | yes | string | - |
value | yes | number | - |
CompartmentAPI
Type: object
| Property | Required | Type | Description |
|---|
medium | yes | string | - |
qualifier | yes | string | - |
subcompartment | yes | string | - |
CategoryEditRequest
Type: object
| Property | Required | Type | Description |
|---|
impactCategory | no | string | - |
methodId | no | UUID | - |
methodology | no | string | - |
name | no | string | - |
op | yes | CategoryEditOp | - |
unit | no | string | - |
CategoryEditOp
Type: string
Allowed values: add, rename, set-unit, remove
ScoringSetAPI
Type: object
| Property | Required | Type | Description |
|---|
displayMultiplier | no | number | - |
name | yes | string | - |
rows | yes | ScoringRowAPI[] | - |
scores | yes | ScoreAPI[] | - |
unit | yes | string | - |
variables | yes | object | - |
weighs | yes | boolean | - |
ScoringRowAPI
Type: object
| Property | Required | Type | Description |
|---|
label | yes | string | - |
normalization | no | Exact | - |
terms | yes | RowTermsAPI | - |
unit | no | string | - |
variable | yes | string | - |
weight | no | number | - |
RowTermsAPI
Type: oneOf(object | object)
RowTermAPI
Type: object
| Property | Required | Type | Description |
|---|
category | yes | string | - |
coefficient | yes | number | - |
methodId | no | UUID | - |
Exact
Type: oneOf(number | string)
ScoreAPI
Type: object
| Property | Required | Type | Description |
|---|
formula | yes | string | - |
name | yes | string | - |
sumOfRows | yes | boolean | - |
ScoringEditRequest
Type: object
| Property | Required | Type | Description |
|---|
formula | no | string | - |
multiplier | no | number | - |
name | no | string | - |
op | yes | ScoringEditOp | - |
row | no | RowDraftAPI | - |
rows | no | RowDraftAPI[] | - |
score | no | string | - |
set | yes | string | - |
unit | no | string | - |
variable | no | string | - |
ScoringEditOp
Type: string
Allowed values: create, remove, rename, set-unit, set-multiplier, add-row, change-row, remove-row, set-formula, set-score, remove-score
RowDraftAPI
Type: object
| Property | Required | Type | Description |
|---|
label | yes | string | - |
normalization | no | Exact | - |
terms | yes | DraftTermAPI[] | - |
unit | no | string | - |
weight | no | number | - |
DraftTermAPI
Type: object
| Property | Required | Type | Description |
|---|
coefficient | yes | number | - |
methodId | yes | UUID | - |
MethodHistoryEntry
Type: object
| Property | Required | Type | Description |
|---|
at | yes | string | - |
by | no | string | - |
change | yes | MethodChangeAPI | - |
inEffect | yes | boolean | - |
kind | yes | HistoryKindAPI | - |
line | yes | integer | - |
undoes | no | integer | - |
via | no | string | - |
HistoryKindAPI
Type: string
Allowed values: change, undo, configuration
MethodChangeAPI
Type: oneOf(object | object | object | object | object | object | object | object | object | object | object | object | object)
ScoringGestureAPI
Type: oneOf(object | object | object | object | object | object | object | object | object | object)
MethodFlowAPI
Type: object
| Property | Required | Type | Description |
|---|
cas | no | string | - |
compartment | no | CompartmentAPI | - |
direction | yes | FlowDirection | - |
flowId | yes | UUID | - |
name | yes | string | - |
unit | yes | string | - |
RefDataListResponse
Type: object
| Property | Required | Type | Description |
|---|
items | yes | RefDataStatusAPI[] | - |
RefDataStatusAPI
Type: object
| Property | Required | Type | Description |
|---|
added | no | string | - |
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[][] | - |
RefDataRowsResponse
Type: object
| Property | Required | Type | Description |
|---|
header | yes | string[] | - |
rows | yes | string[][] | - |
UsagePage
Type: object
| Property | Required | Type | Description |
|---|
boot | yes | string | - |
lines | yes | UsageLine[] | - |
more | yes | boolean | - |
UsageLine
Type: object
| Property | Required | Type | Description |
|---|
at | yes | UTCTime | - |
counted | yes | CountedRelease[] | - |
database | yes | string | - |
heldAs | no | ProcessNaming | - |
kind | yes | UsageKind | - |
process | yes | string | - |
reader | no | string | - |
seq | yes | integer | - |
UsageKind
Type: string
Allowed values: reading, inventory, scoring, contributions, comparison
ProcessNaming
Type: object
| Property | Required | Type | Description |
|---|
activityName | yes | string | - |
location | yes | string | - |
productName | no | string | - |
CountedRelease
Type: object
| Property | Required | Type | Description |
|---|
disclosure | yes | Disclosure | - |
release | yes | Release | - |
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 | - |
FormulaLanguage
Type: object
| Property | Required | Type | Description |
|---|
functions | yes | FormulaFunction[] | - |
operators | yes | string[][] | - |
rules | yes | string[] | - |
FormulaFunction
Type: object
| Property | Required | Type | Description |
|---|
example | yes | string | - |
form | yes | string | - |
meaning | yes | string | - |
name | yes | string | - |
usage | yes | string | - |
value | yes | number | - |
FormulaCheckResponse
Type: object
| Property | Required | Type | Description |
|---|
problem | no | string | - |
reads | yes | string[] | - |
value | no | number | - |
warnings | yes | string[] | - |
FormulaCheckRequest
Type: object
| Property | Required | Type | Description |
|---|
exchange | no | integer | - |
formula | yes | string | - |
process | no | string | - |
DatabaseHistoryEntry
Type: object
| Property | Required | Type | Description |
|---|
at | yes | string | - |
by | no | string | - |
database | yes | string | - |
details | yes | string[] | - |
note | no | string | - |
source | no | Source | - |
summary | yes | string | - |
via | no | string | - |
ParametersEditResponse
Type: object
| Property | Required | Type | Description |
|---|
parametersRemoved | yes | string[] | - |
parametersSet | yes | string[] | - |
restatedProcesses | yes | string[] | - |
transient | yes | boolean | - |
warnings | yes | string[] | - |
ParametersEditRequest
Type: object
| Property | Required | Type | Description |
|---|
note | no | string | - |
removeParameters | yes | string[] | - |
setParameters | yes | SetParameterAPI[] | - |
source | no | Source | - |
ScenarioAPI
Type: object
| Property | Required | Type | Description |
|---|
name | yes | string | - |
parameters | yes | ParameterValue[] | - |
problem | no | string | - |
shipped | yes | boolean | - |
ScenarioSaveRequest
Type: object
| Property | Required | Type | Description |
|---|
parameters | yes | ParameterValue[] | - |