Skip to content

Generated API Reference

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

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

  • OpenAPI version: 3.0.0
  • Operations: 141
  • Schemas: 311
  • Live server Swagger UI: /api/v1/docs
  • Live server OpenAPI JSON: /api/v1/openapi.json
MethodPathOperation IDSummary
GET/api/v1/db/{dbName}/activity/{processId}get_activityLCA / 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}/inventoryget_inventoryLCA / 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-chainget_supply_chainLCA / 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}/aggregateaggregateLCA / 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_activityLCA / 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_impactsLCA / 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_sensitivityLCA / ACV: sensitivity: score relative perturbations of technosphere coefficients.
POST/api/v1/db/{dbName}/activity/{processId}/reduced-model/{collection}get_reduced_modelLCA / 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}/consumersget_consumersLCA / 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-toget_path_toLCA / 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}/comparecompare_activitiesLCA / 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_flowsLCA / 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_activitiesLCA / 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_flowsLCA / 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_activitiesLCA / 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}/factorsget_flow_factorsLCA / 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/methodslist_methodsLCA / 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-mappingget_flow_mappingLCA / 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}/characterizationget_characterizationLCA / ACV: a method's characterization factors matched to database flows.
GET/api/v1/db/{dbName}/method/{methodId}/explain-cf/{flowId}explain_cfLCA / ACV: why one elementary flow scores with its characterization factor, and which method line applied.
GET/api/v1/db/{dbName}/flowssearch_flowsLCA / ACV: search flows by name.
GET/api/v1/db/{dbName}/search-countscount_search_matchesLCA / ACV: how many processes, products and flows one query matches in a database, one call.
GET/api/v1/db/{dbName}/activitiessearch_activitiesLCA / ACV: search activities (processes) by name, geography, product, classification or preset.
POST/api/v1/db/{dbName}/activities - -
GET/api/v1/db/{dbName}/classificationslist_classificationsLCA / ACV: a database's classification systems.
GET/api/v1/db/{dbName}/catalogue - -
GET/api/v1/db/{dbName}/catalogue/fingerprint - -
GET/api/v1/db/{dbName}/comparecompare_databasesLCA / 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_activitiesLCA / ACV: rank N activities on one scoring set, one call.
POST/api/v1/db/{dbName}/impacts/{collection}/{methodId} - -
GET/api/v1/dblist_databasesLCA / ACV: list loaded LCA databases (Agribalyse, ecoinvent…).
POST/api/v1/db/{dbName}/loadload_databaseLCA / ACV: load a configured database into memory, its declared dependencies first (cross-database links).
POST/api/v1/db/{dbName}/unloadunload_databaseLCA / 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-reportget_gap_reportLCA / 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-reportget_quality_reportLCA / 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-reportget_computed_quality_reportLCA / 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-coverageget_characterization_coverageLCA / 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_databaseLCA / 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}/exchangesedit_exchangesLCA / 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/exchangesedit_activitiesedit_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/supplysupply_missing_productGive 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}/comparecompare_method_collectionsLCA / 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}/profileprofile_method_collectionLCA / 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_collectionLCA / ACV: copy a method collection under a new name, to change it.
POST/api/v1/method-collections/{collection}/factorsedit_method_factorsLCA / 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}/categoriesedit_method_categoriesLCA / 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-setslist_scoring_setsLCA / 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-setsedit_scoring_setsLCA / 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}/undoundo_method_editLCA / 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}/historyget_method_historyLCA / 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}/flowssearch_method_flowsLCA / 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-presetslist_presetsLCA / 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-languageget_formula_languageThe 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-checkcheck_formulaCheck 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}/historyget_database_historyEvery 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}/parametersget_database_parametersA 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}/parametersedit_database_parametersSet 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}/scenarioslist_scenariosA database's scenarios: name and parameter values, as {process?, name, value}.
PUT/api/v1/db/{dbName}/scenarios/{name}save_scenarioSave 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_scenarioDrop 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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivityInfo -
404`dbName` or `processId` not found`dbName` or `processId` not found

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
notequerynostring -
sourcequerynostring -

Request body

Media typeSchema
application/json;charset=utf-8ActivityInput

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivityWriteResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
flowquerynostringFlow name or synonym, read as search_flows does: every word, case-blind, any order, punctuation optional
limitquerynointegerMax flows, largest absolute quantity first. Default: 50 over MCP, all over HTTP

Responses

StatusSchemaDescription
200application/json;charset=utf-8: InventoryExport -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
flowquerynostring -
limitquerynointeger -

Request body

Media typeSchema
application/json;charset=utf-8SubstitutionRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: InventoryExport -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
cutoffquerynonumber -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: GraphExport -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
namequerynostringFilter by activity name
limitquerynointegerMax results (default 100)
min-quantityquerynonumber -
offsetquerynointeger -
max-depthquerynointeger -
locationquerynostringFilter by geography/location: that location, plus every location inside it ('US' also matches 'US-WECC'), case-insensitive
productquerynostring -
presetquerynostringClassification preset (list_presets), expanded to its filters; unioned with explicit classification filters.
classificationquerynostring[]Classification system name (e.g. 'Category', 'Category type')
classification-valuequerynostring[] -
classification-modequerynostring[] -
sortquerynostring -
orderquerynostring -
include-edgesquerynoboolean -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: SupplyChainResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
namequerynostring -
limitquerynointeger -
min-quantityquerynonumber -
offsetquerynointeger -
max-depthquerynointeger -
locationquerynostring -
productquerynostring -
presetquerynostring -
classificationquerynostring[] -
classification-valuequerynostring[] -
classification-modequerynostring[] -
sortquerynostring -
orderquerynostring -
include-edgesquerynoboolean -

Request body

Media typeSchema
application/json;charset=utf-8SubstitutionRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: SupplyChainResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
scopequerynostringdirect | supply_chain | biosphere | consumption
is_inputquerynobooleanOnly for scope=direct: true=inputs only, false=outputs only
max_depthquerynointegerOnly for scope=supply_chain: max hops from the root activity
filter_namequerynostringCase-insensitive substring on flow/activity name
filter_name_notquerynostringComma-separated substring exclude list
filter_unitquerynostringWhole unit name, case-insensitive: "MJ" and "mj" are the same unit, "kg" does not match "kgm"
presetquerynostringName of a classification preset (from list_presets): expanded and merged into filter_classification.
filter_classificationquerynostring[]List of "System=Value[:exact]" strings; defaults to 'contains' mode
filter_target_namequerynostringOnly for scope=direct technosphere or scope=consumption: filter by supplier activity name
filter_consumerquerynostringOnly for scope=consumption: case-insensitive substring on the consuming activity's name
filter_consumer_notquerynostringOnly for scope=consumption: comma-separated consumer-name exclude list (each item is a substring; a name containing a comma cannot be expressed)
filter_exchange_typequerynostring -
filter_is_referencequerynobooleanFilter by reference-product flag (typically for outputs)
group_byquerynostringname | flow_id | name_prefix | unit | classification.<system> | location | target_name | consumer_name
aggregatequerynostringsum_quantity | count | share (default: sum_quantity)

Responses

StatusSchemaDescription
200application/json;charset=utf-8: Aggregation -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstringMethod collection name (use list_methods to discover)
exclude-long-termquerynoboolean -
exchange-contributionsquerynoboolean -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: LCIABatchResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstring -
exclude-long-termquerynoboolean -
exchange-contributionsquerynoboolean -

Request body

Media typeSchema
application/json;charset=utf-8SubstitutionRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: LCIABatchResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstringMethod 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.
methodIdpathyesstring -
top-flowsquerynointeger -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: LCIAResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstring -
methodIdpathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8SubstitutionRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: LCIAResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstringMethod 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.
methodIdpathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8SensitivityRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: SensitivityResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstringMethod 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-termquerynoboolean -

Request body

Media typeSchema
application/json;charset=utf-8ReducedModelRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ReducedModel -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
namequerynostringFilter by name (case-insensitive substring)
locationquerynostringFilter by geography/location (e.g. 'FR', 'DE'): that location, plus every location inside it ('RER' also matches 'FR'), case-insensitive
productquerynostringFilter by product name (case-insensitive substring)
presetquerynostringName of a classification preset (from list_presets): expands to its bundled filters
classificationquerynostring[]Classification system name (e.g. 'ISIC rev.4 ecoinvent')
classification-valuequerynostring[] -
classification-modequerynostring[] -
limitquerynointegerMax results (default 1000)
offsetquerynointeger -
max-depthquerynointeger -
sortquerynostring -
orderquerynostring -
include-edgesquerynoboolean -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ConsumersResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
targetquerynostringCase-insensitive name substring to stop at

Responses

StatusSchemaDescription
200application/json;charset=utf-8: JsonValue -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
other_process_idquerynostringProcess ID of the activity to compare against (activityUUID_productUUID format)
other_databasequerynostringLoaded database holding that activity, when it is not this one

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivityComparison -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ChangesQuery

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ChangesPresence -
400Invalid `body`Invalid `body`
404`dbName` or `processId` not found`dbName` or `processId` not found

POST /api/v1/db/{dbName}/activity/{processId}/apply-changes

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ChangesQuery

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ChangesApplied -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstringMethod 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.
methodIdpathyesstring -
limitquerynointegerMax flows to return, sorted by contribution (default 20)
exclude-long-termquerynoboolean -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ContributingFlowsResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstringMethod 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.
methodIdpathyesstring -
limitquerynointegerMax processes to return, sorted by contribution (default 10)
exclude-long-termquerynoboolean -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ContributingActivitiesResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstringMethod collection name the scoring set is configured on (from list_scoring_sets)
scoringSetpathyesstring -
scorepathyesstringName of one score of that scoring set (from list_scoring_sets)
limitquerynointegerMax flows to return, sorted by contribution (default 20)
exclude-long-termquerynoboolean -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ContributingFlowsResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -
collectionpathyesstringMethod collection name the scoring set is configured on (from list_scoring_sets)
scoringSetpathyesstring -
scorepathyesstringName of one score of that scoring set (from list_scoring_sets)
limitquerynointegerMax processes to return, sorted by contribution (default 10)
exclude-long-termquerynoboolean -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ContributingActivitiesResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
flowIdpathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
flowIdpathyesstring -
rolequerynostring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivitySummary[] -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
flowIdpathyesstring -
collectionquerynostringMethod collection name (from list_methods) to ask alone; every loaded collection when omitted

Responses

StatusSchemaDescription
200application/json;charset=utf-8: FlowFactorsResult -
400Invalid `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

StatusSchemaDescription
200application/json;charset=utf-8: MethodSummary[] -

GET /api/v1/method/{methodId}

Parameters

NameInRequiredTypeDescription
methodIdpathyesstring -
collectionquerynostring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodDetail -
400Invalid `collection`Invalid `collection`
404`methodId` not found`methodId` not found

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

Parameters

NameInRequiredTypeDescription
methodIdpathyesstring -
collectionquerynostring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodFactorAPI[] -
400Invalid `collection`Invalid `collection`
404`methodId` not found`methodId` not found

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
methodIdpathyesstring -
collectionquerynostring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MappingStatus -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
methodIdpathyesstring -
collectionquerynostringMethod 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

StatusSchemaDescription
200application/json;charset=utf-8: FlowCFMapping -
400Invalid `collection`Invalid `collection`
404`dbName` or `methodId` not found`dbName` or `methodId` not found

GET /api/v1/db/{dbName}/method-collection/{collection}/coverage

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
collectionpathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
methodIdpathyesstring -
flowquerynostringFilter by flow name (case-insensitive substring, matches both method CF name and database flow name)
limitquerynointegerMax results (default 20)
collectionquerynostringMethod 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

StatusSchemaDescription
200application/json;charset=utf-8: CharacterizationResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
methodIdpathyesstring -
flowIdpathyesstring -
collectionquerynostringMethod 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

StatusSchemaDescription
200application/json;charset=utf-8: ExplainCFResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
qquerynostring -
langquerynostring -
kindquerynostringKeep only these kinds of flow: technosphere | biosphere | waste. Name several separated by commas, as in "biosphere,waste". Omit for all three.
limitquerynointegerMax results (default 20)
offsetquerynointeger -
sortquerynostring -
orderquerynostring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: SearchResults_FlowSearchResult -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
qquerynostring -
sortquerynostring -
exactquerynoboolean -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: SearchCountsAPI -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
namequerynostringWords 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.
geoquerynostringLocation (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'.
productquerynostringProduct name filter
exactquerynobooleanTrue: the name equals (case aside) instead of containing, and geo is that location alone, not the ones inside it
presetquerynostringClassification preset (list_presets), expanded to its filters; combines with explicit classification filters.
classificationquerynostring[]Classification system (e.g. 'ISIC rev.4 ecoinvent', 'CPC'; list_classifications).
classification-valuequerynostring[] -
classification-modequerynostring[] -
processquerynostring[]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.
limitquerynointegerMax results (default 20)
offsetquerynointeger -
sortquerynostring -
orderquerynostring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: SearchResults_ActivitySummary -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ActivityWriteRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivityWriteResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ClassificationSystem[] -
404`dbName` not found`dbName` not found

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
offsetquerynointeger -
limitquerynointeger -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: CataloguePage -
400Invalid `limit` or `offset`Invalid `limit` or `offset`
404`dbName` not found`dbName` not found

GET /api/v1/db/{dbName}/catalogue/fingerprint

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
other_databasequerynostringLoaded database to compare against, usually the newer version
limitquerynointegerMax entries per list (added, removed, changed, redated, ambiguous, unchanged), in name order (default: all). The counts always cover the full lists.

Responses

StatusSchemaDescription
200application/json;charset=utf-8: DatabaseComparison -
400Invalid `limit` or `other_database`Invalid `limit` or `other_database`
404`dbName` not found`dbName` not found

GET /api/v1/db/{dbName}/score-pairs

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
other_databasequerynostring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ScorePairs -
400Invalid `other_database`Invalid `other_database`
404`dbName` not found`dbName` not found

POST /api/v1/db/{dbName}/score-units

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ScoreUnitsRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ScoreUnits -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
collectionpathyesstringMethod collection name
top-flowsquerynointeger -
exclude-long-termquerynoboolean -

Request body

Media typeSchema
application/json;charset=utf-8BatchImpactsRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: BatchImpactsResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
collectionpathyesstring -
methodIdpathyesstring -
top-flowsquerynointeger -
exclude-long-termquerynoboolean -

Request body

Media typeSchema
application/json;charset=utf-8BatchImpactsRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: BatchImpactsResponse -
400Invalid `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

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`dbName` not found`dbName` not found

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8RelinkRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: RelinkResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
limitquerynointegerMax gaps, biggest first (default all); header counts cover the full report.

Responses

StatusSchemaDescription
200application/json;charset=utf-8: GapReportAPI -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
limitquerynointegerMax findings per check, worst first (default all); offenderCount covers the full list.

Responses

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

GET /api/v1/db/{dbName}/quality-report.csv

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
limitquerynointeger -

Responses

StatusSchemaDescription
200text/csv;charset=utf-8: QualityReportAPI -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
collectionquerynostringMethod collection to score with; required when several are loaded.
limitquerynointegerMax findings per check, worst first (default all); offenderCount covers the full list.

Responses

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

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
collectionquerynostring -
limitquerynointeger -

Responses

StatusSchemaDescription
200text/csv;charset=utf-8: ComputedQualityReportAPI -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
collectionquerynostringOne loaded method collection (list_methods); every one when omitted.
limitquerynointegerMax bridge groups per collection (default all); bridgeGroupCount covers the full list.

Responses

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

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
newNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
newNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8DeriveRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: LoadDatabaseResponse -
400Invalid `body`Invalid `body`
404`dbName` or `newName` not found`dbName` or `newName` not found

GET /api/v1/db/{dbName}/system-model

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: SystemModelAPI -
404`dbName` not found`dbName` not found

DELETE /api/v1/db/{dbName}

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`dbName` not found`dbName` not found

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8DeleteSelectionRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: DeleteSelectionResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
processIdpathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ExchangeEditRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ExchangeEditResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ActivitiesEditRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivitiesEditResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8SupplyMissingRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivitiesEditResponse -
400Invalid `body`Invalid `body`
404`dbName` not found`dbName` not found

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8DatabaseExportRequest

Responses

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

GET /api/v1/db/{dbName}/files/{path}

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
pathpathyesstring -

Responses

StatusSchemaDescription
200application/octet-stream: OctetStream -
404`dbName` or `path` not found`dbName` or `path` not found

PUT /api/v1/db/{dbName}/licence

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8Licence

Responses

StatusSchemaDescription
200application/json;charset=utf-8: Licence -
400Invalid `body`Invalid `body`
404`dbName` not found`dbName` not found

PUT /api/v1/db/{dbName}/release

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8Release

Responses

StatusSchemaDescription
200application/json;charset=utf-8: Release -
400Invalid `body`Invalid `body`
404`dbName` not found`dbName` not found

PUT /api/v1/db/{dbName}/display-name

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8string

Responses

StatusSchemaDescription
200application/json;charset=utf-8: string -
400Invalid `body`Invalid `body`
404`dbName` not found`dbName` not found

PUT /api/v1/db/{dbName}/description

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8string

Responses

StatusSchemaDescription
200application/json;charset=utf-8: string -
400Invalid `body`Invalid `body`
404`dbName` not found`dbName` not found

POST /api/v1/db/{dbName}/accept-substitution

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ReleaseSubstitution

Responses

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

POST /api/v1/db/upload

Parameters

NameInRequiredTypeDescription
namequerynostring -
descriptionquerynostring -

Request body

Media typeSchema
application/octet-streamUploadChunk[]

Responses

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

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: DatabaseSetupInfo -
404`dbName` not found`dbName` not found

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -
depNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
depNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8JsonValue

Responses

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

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

Parameters

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`dbName` not found`dbName` not found

GET /api/v1/method-collections

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodCollectionListResponse -

GET /api/v1/method-collections/available

Responses

StatusSchemaDescription
200application/json;charset=utf-8: AvailableMethodCollection[] -

POST /api/v1/method-collections/available/{name}/install

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

POST /api/v1/method-collections/upload

Parameters

NameInRequiredTypeDescription
namequerynostring -
descriptionquerynostring -
flows_fromquerynostring -

Request body

Media typeSchema
application/octet-streamUploadChunk[]

Responses

StatusSchemaDescription
200application/json;charset=utf-8: UploadResponse -
400Invalid `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

NameInRequiredTypeDescription
namepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ExportRequest

Responses

StatusSchemaDescription
200application/octet-stream: OctetStream -
400Invalid `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

NameInRequiredTypeDescription
collectionpathyesstringBase method collection, usually the older version
other_collectionquerynostringLoaded method collection to compare against
pairsquerynostring[]Categories to pair by hand, each written "base=other" with the two category names; taken before any other pairing
categoryquerynostringCompare 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
limitquerynointegerMax entries per list of each category (added, removed, changed, ambiguous, unconvertible), in order (default: all). The counts always cover the full lists.

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodCollectionComparison -
400Invalid `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

NameInRequiredTypeDescription
collectionpathyesstringLoaded method collection to profile

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
collectionpathyesstringMethod collection to copy
newNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
collectionpathyesstringLoaded method collection of one's own: a copy or an upload

Request body

Media typeSchema
application/json;charset=utf-8FactorEditRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodEditResponse -
400Invalid `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

NameInRequiredTypeDescription
collectionpathyesstringLoaded method collection of one's own: a copy or an upload

Request body

Media typeSchema
application/json;charset=utf-8CategoryEditRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodEditResponse -
400Invalid `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

NameInRequiredTypeDescription
collectionpathyesstringMethod collection name. If omitted, returns scoring sets across all loaded collections, grouped by collection.

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
collectionpathyesstringLoaded method collection of one's own: a copy or an upload

Request body

Media typeSchema
application/json;charset=utf-8ScoringEditRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodEditResponse -
400Invalid `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

NameInRequiredTypeDescription
collectionpathyesstringLoaded method collection of one's own
linequerynointegerThe journal line to undo (from get_method_history); the latest change in effect when absent

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodEditResponse -
400Invalid `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

NameInRequiredTypeDescription
collectionpathyesstringMethod collection name

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
collectionpathyesstringLoaded method collection
qquerynostringWords the flow name holds; every flow when absent
limitquerynointegerMax flows to return, in name order (default: 50)

Responses

StatusSchemaDescription
200application/json;charset=utf-8: MethodFlowAPI[] -
400Invalid `limit` or `q`Invalid `limit` or `q`
404`collection` not found`collection` not found

GET /api/v1/flow-synonyms

Responses

StatusSchemaDescription
200application/json;charset=utf-8: RefDataListResponse -

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

POST /api/v1/flow-synonyms/upload

Parameters

NameInRequiredTypeDescription
namequerynostring -
descriptionquerynostring -

Request body

Media typeSchema
application/octet-streamUploadChunk[]

Responses

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

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: SynonymGroupsResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/octet-stream: OctetStream -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: RefDataRowsResponse -
404`name` not found`name` not found

GET /api/v1/compartment-mappings

Responses

StatusSchemaDescription
200application/json;charset=utf-8: RefDataListResponse -

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

POST /api/v1/compartment-mappings/upload

Parameters

NameInRequiredTypeDescription
namequerynostring -
descriptionquerynostring -

Request body

Media typeSchema
application/octet-streamUploadChunk[]

Responses

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

GET /api/v1/compartment-mappings/{name}/download

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/octet-stream: OctetStream -
404`name` not found`name` not found

GET /api/v1/compartment-mappings/{name}/rows

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: RefDataRowsResponse -
404`name` not found`name` not found

GET /api/v1/units

Responses

StatusSchemaDescription
200application/json;charset=utf-8: RefDataListResponse -

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

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

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

DELETE /api/v1/units/{name}

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ActivateResponse -
404`name` not found`name` not found

POST /api/v1/units/upload

Parameters

NameInRequiredTypeDescription
namequerynostring -
descriptionquerynostring -

Request body

Media typeSchema
application/octet-streamUploadChunk[]

Responses

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

GET /api/v1/units/{name}/download

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/octet-stream: OctetStream -
404`name` not found`name` not found

GET /api/v1/units/{name}/rows

Parameters

NameInRequiredTypeDescription
namepathyesstring -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: RefDataRowsResponse -
404`name` not found`name` not found

GET /api/v1/logs

Parameters

NameInRequiredTypeDescription
sincequerynointeger -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: JsonValue -
400Invalid `since`Invalid `since`

GET /api/v1/usage

Parameters

NameInRequiredTypeDescription
afterquerynointeger -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: UsagePage -
400Invalid `after`Invalid `after`

DELETE /api/v1/usage

Parameters

NameInRequiredTypeDescription
bootqueryyesstring -
throughqueryyesinteger -

Responses

StatusSchemaDescription
200application/json;charset=utf-8: - -
400Invalid `through` or `boot`Invalid `through` or `boot`

POST /api/v1/auth

Request body

Media typeSchema
application/json;charset=utf-8LoginRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: JsonValue -
400Invalid `body`Invalid `body`

GET /api/v1/version

Responses

StatusSchemaDescription
200application/json;charset=utf-8: JsonValue -

GET /api/v1/hosting

Responses

StatusSchemaDescription
200application/json;charset=utf-8: JsonValue -

GET /api/v1/stats

Responses

StatusSchemaDescription
200application/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

StatusSchemaDescription
200application/json;charset=utf-8: ClassificationPresetInfo[] -

GET /api/v1/licences

Responses

StatusSchemaDescription
200application/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

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8FormulaCheckRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: FormulaCheckResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -

Request body

Media typeSchema
application/json;charset=utf-8ParametersEditRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ParametersEditResponse -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -

Responses

StatusSchemaDescription
200application/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

NameInRequiredTypeDescription
dbNamepathyesstring -
namepathyesstringName of the scenario

Request body

Media typeSchema
application/json;charset=utf-8ScenarioSaveRequest

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ScenarioAPI[] -
400Invalid `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

NameInRequiredTypeDescription
dbNamepathyesstring -
namepathyesstringName of the scenario

Responses

StatusSchemaDescription
200application/json;charset=utf-8: ScenarioAPI[] -
404`dbName` or `name` not found`dbName` or `name` not found

GET /api/v1/openapi.json

Responses

StatusSchemaDescription
200application/json;charset=utf-8: JsonValue -

ActivityInfo

Type: object

PropertyRequiredTypeDescription
activityyesActivityForAPI -
linksyesActivityLinks -
metadatayesActivityMetadata -
statisticsyesActivityStats -

ActivityForAPI

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
allProductsyesActivitySummary[] -
classificationsyesobject -
databaseParametersyesParameterAPI[] -
datesyesDatasetDates -
descriptionyesstring[] -
documentationyesDocSection[] -
exchangesyesExchangeWithUnit[] -
locationyesstring -
nativeIdnostring -
nativeTypenoNativeActivityType -
parametersyesParameterAPI[] -
processIdyesstring -
productAmountnonumber -
productNamenostring -
productUnitnostring -
synonymsyesobject -
unityesstring -
withheldnoWithheldExchanges -

DocSection

Type: object

PropertyRequiredTypeDescription
labelyesstring -
textyesstring -

DatasetDates

Type: object

PropertyRequiredTypeDescription
creatednoDay -
lastRevisednoDay -
statednoDay -

Day

Type: string

ActivitySummary

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
allocationBynostring -
allocationFormulanostring -
allocationPercentnonumber -
blockyesstring -
blockProductsyesinteger -
locationyesstring -
massAllocationPercentnonumber -
nativeTypenoNativeActivityType -
processIdyesstring -
productAmountyesnumber -
productNameyesstring -
productUnityesstring -

NativeActivityType

Type: object

PropertyRequiredTypeDescription
codenointeger -
labelyesstring -
sourceyesstringAllowed values: ecospold2, simapro, ilcd
special_codenointeger -
special_labelnostring -

ExchangeWithUnit

Type: object

PropertyRequiredTypeDescription
compartmentnoCompartment -
exCommentnostring -
exchangeyesExchange -
flowNameyesstring -
pedigreenoPedigree -
positionyesinteger -
selectornoExchangeSelectorAPI -
targetActivityNamenostring -
targetLocationnostring -
targetProcessIdnostring -
unitNameyesstring -
wasteRolenoWasteRole -

Exchange

Type: oneOf(object | object | object)

UUID

Type: string

TechRole

Type: string

Allowed values: ReferenceProduct, Coproduct, AvoidedProduct, ReferenceInput, Input

SupplierClaim

Type: oneOf(object | object | object | object | object)

Pedigree

Type: object

PropertyRequiredTypeDescription
completenessyesinteger -
geographicalyesinteger -
reliabilityyesinteger -
technologicalyesinteger -
temporalyesinteger -

DeclaredShare

Type: object

PropertyRequiredTypeDescription
bynostring -
formulanostring -
percentyesnumber -

ExchangeProperties

Type: object

PropertyRequiredTypeDescription
dryMassnoStatedAmount -
pricenoPrice -
wetMassnoStatedAmount -

StatedAmount

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
unityesstring -

Price

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
originyesstringAllowed values: stated, deduced from share
unitnostring -

ExchangeFormula

Type: object

PropertyRequiredTypeDescription
namenostring -
textyesstring -

BioDirection

Type: string

Allowed values: Resource, Emission

Compartment

Type: object

PropertyRequiredTypeDescription
nameyesMedium -
subnostring -

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

PropertyRequiredTypeDescription
flownostring -
kindyesstring -
locationnostring -
providernostring -

WithheldExchanges

Type: object

PropertyRequiredTypeDescription
linesyesExchangeName[] -
reasonyesstring -

ExchangeName

Type: object

PropertyRequiredTypeDescription
compartmentnoCompartment -
flowNameyesstring -
isInputyesboolean -
kindyesExchangeKind -
targetActivityNamenostring -
targetLocationnostring -
targetProcessIdnostring -
unitNameyesstring -

ExchangeKind

Type: string

Allowed values: technosphere, biosphere, waste

ParameterAPI

Type: object

PropertyRequiredTypeDescription
descriptionyesstring -
formulanostring -
nameyesstring -
uncertaintynoUncertainty -
unitnostring -
valuenonumber -

Uncertainty

Type: object

PropertyRequiredTypeDescription
distributionyesstringAllowed values: lognormal, normal, triangular, uniform
geometricMeannonumber -
geometricSdnonumber -
maximumnonumber -
meannonumber -
minimumnonumber -
modenonumber -
sdnonumber -

ActivityMetadata

Type: object

PropertyRequiredTypeDescription
biosphereExchangesyesinteger -
hasReferenceProductyesboolean -
referenceProductFlownoUUID -
technosphereInputsyesinteger -
totalFlowsyesinteger -
wasteExchangesLinkedyesinteger -
wasteExchangesOrphanyesinteger -

ActivityStats

Type: object

PropertyRequiredTypeDescription
inputCountyesinteger -
locationyesstring -
outputCountyesinteger -
totalExchangesyesinteger -

ActivityLinks

Type: object

PropertyRequiredTypeDescription
flowsUrlyesstring -
inputsUrlyesstring -
outputsUrlyesstring -
referenceProductUrlnostring -

ProcessDivisionAPI

Type: object

PropertyRequiredTypeDescription
parentActivityyesstring -
parentDatabaseyesstring -
parentNameyesstring -
parentProcessIdyesstring -
ruleyesstring -
sharenonumber -

FlowSummary

Type: object

PropertyRequiredTypeDescription
flowyesApiFlow -
roleyesFlowRole -
unitNameyesstring -
usageCountyesinteger -

ApiFlow

Type: oneOf(object | object | object)

PropertyRequiredTypeDescription
kindyesstringAllowed values: technosphere, biosphere, unresolved

TechnosphereFlow

Type: object

PropertyRequiredTypeDescription
cASnostring -
idyesUUID -
nameyesstring -
substanceIdnointeger -
synonymsyesobject -
unitIdyesUUID -

BiosphereFlow

Type: object

PropertyRequiredTypeDescription
cASnostring -
compartmentnoCompartment -
idyesUUID -
nameyesstring -
substanceIdnointeger -
synonymsyesobject -
unitIdyesUUID -

FlowRole

Type: string

Allowed values: InputFlow, OutputFlow, ReferenceProductFlow

ExchangeDetail

Type: object

PropertyRequiredTypeDescription
exchangeyesExchange -
exchangeUnitNameyesstring -
flowyesApiFlow -
flowUnitNameyesstring -
targetActivitynoActivitySummary -
unityesUnit -

Unit

Type: object

PropertyRequiredTypeDescription
commentyesstring -
idyesUUID -
nameyesstring -
symbolyesstring -

FlowDetail

Type: object

PropertyRequiredTypeDescription
flowyesApiFlow -
unitNameyesstring -
usageCountyesinteger -

TreeExport

Type: object

PropertyRequiredTypeDescription
edgesyesTreeEdge[] -
nodesyesobject -
treeyesTreeMetadata -

TreeMetadata

Type: object

PropertyRequiredTypeDescription
expandableNodesyesinteger -
leafNodesyesinteger -
loopNodesyesinteger -
maxDepthyesinteger -
rootIdyesstring -
totalNodesyesinteger -

ExportNode

Type: object

PropertyRequiredTypeDescription
childrenCountyesinteger -
compartmentnostring -
depthyesinteger -
descriptionyesstring[] -
idyesstring -
locationyesstring -
loopTargetnostring -
nameyesstring -
nodeTypeyesNodeType -
parentIdnostring -
unityesstring -

NodeType

Type: string

Allowed values: ActivityNode, LoopNode, MissingNode, BiosphereEmissionNode, BiosphereResourceNode

TreeEdge

Type: object

PropertyRequiredTypeDescription
edgeTypeyesEdgeType -
flowyesFlowInfo -
fromyesstring -
quantityyesnumber -
toyesstring -
unityesstring -

FlowInfo

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
idyesUUID -
nameyesstring -

EdgeType

Type: string

Allowed values: TechnosphereEdge, BiosphereEmissionEdge, BiosphereResourceEdge

InventoryExport

Type: object

PropertyRequiredTypeDescription
cutoffInputsyesCutoffInput[] -
flowsyesInventoryFlowDetail[] -
metadatayesInventoryMetadata -
statisticsyesInventoryStatistics -
withheldCutoffsyesWithheldCutoffs[] -

InventoryMetadata

Type: object

PropertyRequiredTypeDescription
emissionFlowsyesinteger -
matchedFlowsyesinteger -
resourceFlowsyesinteger -
rootActivityyesActivitySummary -
totalFlowsyesinteger -

InventoryFlowDetail

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
flowyesBiosphereFlow -
isEmissionyesboolean -
quantityyesnumber -
unitNameyesstring -

InventoryStatistics

Type: object

PropertyRequiredTypeDescription
emissionQuantityyesnumber -
resourceQuantityyesnumber -
topCategoriesyesobject[][] -
totalQuantityyesnumber -

CutoffInput

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
consumersyesinteger -
databaseyesstring -
locationyesstring -
productyesstring -
reasonsyesBlockerReason[] -
suppliernostring -
unityesstring -

BlockerReason

Type: object

PropertyRequiredTypeDescription
detailnostring -
reasonyesstring -

WithheldCutoffs

Type: object

PropertyRequiredTypeDescription
countyesinteger -
databaseyesstring -

GraphExport

Type: object

PropertyRequiredTypeDescription
edgesyesGraphEdge[] -
nodesyesGraphNode[] -
unitGroupsyesobject -

GraphNode

Type: object

PropertyRequiredTypeDescription
labelyesstring -
locationyesstring -
nodeIdyesinteger -
processIdyesstring -
unityesstring -
valueyesnumber -

GraphEdge

Type: object

PropertyRequiredTypeDescription
flowNameyesstring -
sourceyesinteger -
targetyesinteger -
unityesstring -
valueyesnumber -

SupplyChainResponse

Type: object

PropertyRequiredTypeDescription
cutoffInputsyesCutoffInput[] -
edgesyesSupplyChainEdge[] -
filteredActivitiesyesinteger -
rootyesActivitySummary -
supplyChainyesSupplyChainEntry[] -
totalActivitiesyesinteger -
withheldCutoffsyesWithheldCutoffs[] -
withheldDatabasesyesWithheldProcesses[] -
withheldInputsyesWithheldInput[] -

SupplyChainEntry

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
classificationsyesobject -
databaseNameyesstring -
depthyesinteger -
locationyesstring -
processIdyesstring -
quantityyesnumber -
scalingFactoryesnumber -
unityesstring -
upstreamCountyesinteger -

SupplyChainEdge

Type: object

PropertyRequiredTypeDescription
edgeAmountyesnumber -
edgeFromyesstring -
edgeFromDbyesstring -
edgeToyesstring -
edgeToDbyesstring -

WithheldProcesses

Type: object

PropertyRequiredTypeDescription
databaseyesstring -
processesyesinteger -
reasonyesstring -

WithheldInput

Type: object

PropertyRequiredTypeDescription
consumeryesstring -
databaseyesstring -

Aggregation

Type: object

PropertyRequiredTypeDescription
cutoffInputsyesCutoffInput[] -
filteredCountyesinteger -
filteredTotalyesnumber -
filteredUnitnostring -
groupsyesAggregationGroup[] -
scopeyesstring -
withheldCutoffsyesWithheldCutoffs[] -
withheldDatabasesyesWithheldProcesses[] -

AggregationGroup

Type: object

PropertyRequiredTypeDescription
countyesinteger -
keyyesstring -
quantityyesnumber -
sharenonumber -
unitnostring -

LCIABatchResult

Type: object

PropertyRequiredTypeDescription
availableNWsetsyesstring[] -
basisnoScoreBasis -
cutoffInputsyesCutoffInput[] -
cutoffWasteyesCutoffWasteFlow[] -
normWeightSetNamenostring -
resultsyesLCIAResult[] -
scoringIndicatorsyesobject -
scoringResultsyesobject -
scoringRowsyesobject -
scoringUnitsyesobject -
singleScorenonumber -
singleScoreUnitnostring -
withheldyesstring[] -
withheldCutoffsyesWithheldCutoffs[] -

LCIAResult

Type: object

PropertyRequiredTypeDescription
basisnoScoreBasis -
categoryyesstring -
cutoffInputsyesCutoffInput[] -
damageCategoryyesstring -
exchangeContributionsyesExchangeContribution[] -
functionalUnityesstring -
mappedFlowsyesinteger -
methodIdyesUUID -
methodNameyesstring -
normalizedScorenonumber -
probableMissesnoProbableMisses -
scoreyesnumber -
topContributorsyesFlowContributionEntry[] -
unityesstring -
weightedScorenonumber -
withheldnostring -
withheldCutoffsyesWithheldCutoffs[] -
withheldDatabasesyesWithheldShare[] -

FlowContributionEntry

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
cfValueyesnumber -
compartmentnostring -
contributionyesnumber -
flowIdyesstring -
flowNameyesstring -
matchKindnostring -
sharePctyesnumber -

WithheldShare

Type: object

PropertyRequiredTypeDescription
contributionyesnumber -
databaseyesstring -
reasonyesstring -
sharePctyesnumber -

ExchangeContribution

Type: object

PropertyRequiredTypeDescription
contributionyesnumber -
positionyesinteger -
sharePctyesnumber -

ProbableMisses

Type: object

PropertyRequiredTypeDescription
moreyesinteger -
shownyesProbableMissEntry[] -
withheldyesstring[] -

ProbableMissEntry

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
compartmentnostring -
factoryesnumber -
flowIdyesstring -
flowNameyesstring -
quantityyesnumber -
unityesstring -
upToyesnumber -
upToSharePctyesnumber -
writtenAtyesstring[] -

ScoreBasis

Type: object

PropertyRequiredTypeDescription
databasesyesBasisDatabase[] -
engineyesstring -
methodsyesBasisMethods -
parameterSetsyesParameterValue[][] -
substitutionsyesSubstitution[] -

BasisDatabase

Type: object

PropertyRequiredTypeDescription
editedyesboolean -
nameyesstring -
patchedyesboolean -
readsFilesOfnostring -
reallocatedyesboolean -
releasenoRelease -

Release

Type: object

PropertyRequiredTypeDescription
nameyesstring -
systemModelnostring -
versionyesstring -

BasisMethods

Type: object

PropertyRequiredTypeDescription
collectionyesstring -
copyOfnostring -
modifiedyesboolean -

Substitution

Type: object

PropertyRequiredTypeDescription
consumernostring -
fromyesstring -
toyesstring -

ParameterValue

Type: object

PropertyRequiredTypeDescription
nameyesstring -
processnostring -
valueyesnumber -

ScoringIndicator

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
valueyesnumber -

CutoffWasteFlow

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
flowIdyesUUID -
flowNameyesstring -
unityesstring -

SubstitutionRequest

Type: object

PropertyRequiredTypeDescription
parametersnoParameterValue[] -
substitutionsnoSubstitution[] -

SensitivityResponse

Type: object

PropertyRequiredTypeDescription
baselineyesLCIAResult -
cutoffInputsyesCutoffInput[] -
perturbedyesPerturbedEntry[] -
withheldCutoffsyesWithheldCutoffs[] -

PerturbedEntry

Type: object

PropertyRequiredTypeDescription
deltaImpactnonumber -
errornostring -
impactnoLCIAResult -
perturbationyesPerturbation -

Perturbation

Type: object

PropertyRequiredTypeDescription
consumeryesstring -
deltayesnumber -
labelnostring -
supplieryesstring -

SensitivityRequest

Type: object

PropertyRequiredTypeDescription
perturbationsyesPerturbation[] -

ReducedModel

Type: object

PropertyRequiredTypeDescription
baselineyesnumber[] -
excludeLongTermyesboolean -
methodsyesReducedMethod[] -
parametersyesFreeParameter[] -
processesyesModelProcess[] -
scoringSetsyesModelScoringSet[] -
suppliersyesModelSupplier[] -

ReducedMethod

Type: object

PropertyRequiredTypeDescription
idyesUUID -
nameyesstring -
unityesstring -

FreeParameter

Type: object

PropertyRequiredTypeDescription
parameteryesParameterAPI -
processnostring -

ModelProcess

Type: object

PropertyRequiredTypeDescription
bindingsyesModelBinding[] -
biosphereyesModelEmission[] -
nameyesstring -
parametersyesobject -
processIdyesstring -
referenceyesModelReference -
scalingyesnumber -
technosphereyesModelInput[] -
valuesyesobject -

ModelBinding

Type: object

PropertyRequiredTypeDescription
formulayesFormula -
nameyesstring -

Formula

Type: object

A number, a name in lower case, or an array: a function or an operator, then its arguments.

ModelReference

Type: object

PropertyRequiredTypeDescription
inputsyesModelLine[] -
outputsyesModelLine[] -
selfLoopsyesModelLine[] -

ModelLine

Type: object

PropertyRequiredTypeDescription
formulanoFormula -
storedyesnumber -

ModelInput

Type: object

PropertyRequiredTypeDescription
factoryesnumber -
lineyesModelLine -
supplieryesinteger -

ModelEmission

Type: object

PropertyRequiredTypeDescription
factorsyesnumber[] -
lineyesModelLine -

ModelSupplier

Type: object

PropertyRequiredTypeDescription
databaseyesstring -
processIdyesstring -
scalingsyesnumber[] -
scoresyesnumber[] -

ModelScoringSet

Type: object

PropertyRequiredTypeDescription
computedyesModelBinding[] -
displayMultiplieryesnumber -
nameyesstring -
normalizationyesobject -
scoresyesobject -
unityesstring -
variablesyesobject -
weightingyesobject -

ReducedModelRequest

Type: object

PropertyRequiredTypeDescription
parametersyesParameterName[] -

ParameterName

Type: object

PropertyRequiredTypeDescription
nameyesstring -
processnostring -

ConsumersResponse

Type: object

PropertyRequiredTypeDescription
edgesyesSupplyChainEdge[] -
resultsyesSearchResults_ConsumerResult -

SearchResults_ConsumerResult

Type: object

PropertyRequiredTypeDescription
hasMoreyesboolean -
limityesinteger -
offsetyesinteger -
resultsyesConsumerResult[] -
searchTimeMsyesnumber -
totalyesinteger -

ConsumerResult

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
classificationsyesobject -
depthyesinteger -
locationyesstring -
processIdyesstring -
productAmountyesnumber -
productNameyesstring -
productUnityesstring -

JsonValue

Type: object

ActivityComparison

Type: object

PropertyRequiredTypeDescription
baseyesActivitySummary -
exchangesyesExchangeChange[] -
otheryesActivitySummary -
summaryyesSummaryChange[] -
uncomparedyesUncomparedLine[] -

SummaryChange

Type: oneOf(object | object | object | object | object | object)

ExchangeChange

Type: object

PropertyRequiredTypeDescription
changeyesLineChange -
compartmentnoCompartment -
flowIdyesUUID -
flowNameyesstring -
roleyesLineRole -

LineRole

Type: oneOf(object | object | object)

WasteSide

Type: string

Allowed values: WasteInput, WasteOutput

LineChange

Type: oneOf(object | object | object | object)

Quantity

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
unityesstring -

LineMatch

Type: string

Allowed values: SameFlow, SameFlowName

Supplier

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
locationyesstring -

UncomparedLine

Type: object

PropertyRequiredTypeDescription
compartmentnoCompartment -
flowNameyesstring -
reasonyesUncomparedReason -
roleyesLineRole -

UncomparedReason

Type: oneOf(object | object)

ChangesPresence

Type: object

PropertyRequiredTypeDescription
exchangesyesChangePresence[] -
summaryyesChangePresence[] -

ChangePresence

Type: string

Allowed values: present, absent, different, line-gone

ChangesQuery

Type: object

PropertyRequiredTypeDescription
exchangesyesExchangeChange[] -
notenostring -
sourcenoSource -
summaryyesSummaryChange[] -

Source

Type: object

PropertyRequiredTypeDescription
documentyesstring -
pagenointeger -
passagenostring -

ChangesApplied

Type: object

PropertyRequiredTypeDescription
exchangesyesChangeOutcome[] -
summaryyesChangeOutcome[] -

ChangeOutcome

Type: object

PropertyRequiredTypeDescription
outcomeyesstringAllowed values: applied, present, different, line-gone, not-applicable
reasonnostring -

ContributingFlowsResult

Type: object

PropertyRequiredTypeDescription
basisyesScoreBasis -
cutoffInputsyesCutoffInput[] -
methodyesstring -
topFlowsyesFlowContributionEntry[] -
totalScoreyesnumber -
unityesstring -
withheldCutoffsyesWithheldCutoffs[] -
withheldDatabasesyesWithheldShare[] -

ContributingActivitiesResult

Type: object

PropertyRequiredTypeDescription
activitiesyesActivityContribution[] -
basisyesScoreBasis -
cutoffInputsyesCutoffInput[] -
methodyesstring -
totalScoreyesnumber -
unityesstring -
withheldCutoffsyesWithheldCutoffs[] -
withheldDatabasesyesWithheldShare[] -

ActivityContribution

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
contributionyesnumber -
locationyesstring -
processIdyesstring -
productNameyesstring -
sharePctyesnumber -

FlowFactorsResult

Type: object

PropertyRequiredTypeDescription
collectionsyesCollectionFactors[] -
flowyesExplainedFlowAPI -

ExplainedFlowAPI

Type: object

PropertyRequiredTypeDescription
casnostring -
categoryyesstring -
compartmentnostring -
idyesstring -
nameyesstring -
unityesstring -

CollectionFactors

Type: object

PropertyRequiredTypeDescription
collectionyesstring -
factorsyesExplainCFResult[] -
noFactoryesMethodSummary[] -

ExplainCFResult

Type: object

PropertyRequiredTypeDescription
explanationyesstring[] -
flowyesExplainedFlowAPI -
matchnoExplainedMatchAPI -
methodyesstring -
methodIdyesUUID -
methodUnityesstring -
outcomeyesstring -
regionalFactorCountyesinteger -
stepsTriedyesExplainedStepAPI[] -

ExplainedMatchAPI

Type: object

PropertyRequiredTypeDescription
cfUnityesstring -
cfValueyesnumber -
matchStrategyyesstring -
methodCasnostring -
methodFlowNameyesstring -
refusalnostring -
rungyesstring -
unitConversionnostring -

ExplainedStepAPI

Type: object

PropertyRequiredTypeDescription
resultyesstring -
rungyesstring -
vetonostring -

MethodSummary

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
collectionyesstring -
factorCountyesinteger -
idyesUUID -
nameyesstring -
unityesstring -

MethodDetail

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
descriptionnostring -
factorCountyesinteger -
idyesUUID -
methodologynostring -
nameyesstring -
unityesstring -

MethodFactorAPI

Type: object

PropertyRequiredTypeDescription
compartmentnostring -
directionyesstring -
flowNameyesstring -
flowRefyesUUID -
locationnostring -
readingyesFactorReading -
unitnostring -
valueyesnumber -

FactorReading

Type: object

PropertyRequiredTypeDescription
locationnoReadLocation -
mediumnostring -

ReadLocation

Type: object

PropertyRequiredTypeDescription
codeyesstring -
fromyesLocationSource -

LocationSource

Type: string

Allowed values: InField, InName

MappingStatus

Type: object

PropertyRequiredTypeDescription
coverageyesnumber -
dbBiosphereCountyesinteger -
mappedByCASyesinteger -
mappedByNameyesinteger -
mappedBySynonymyesinteger -
mappedByUUIDyesinteger -
methodIdyesUUID -
methodNameyesstring -
totalFactorsyesinteger -
uniqueDbFlowsMatchedyesinteger -
unmappedyesinteger -
unmappedFlowsyesUnmappedFlowAPI[] -

UnmappedFlowAPI

Type: object

PropertyRequiredTypeDescription
compartmentnostring -
directionyesstring -
flowNameyesstring -
flowRefyesUUID -

FlowCFMapping

Type: object

PropertyRequiredTypeDescription
flowsyesFlowCFEntry[] -
matchedFlowsyesinteger -
methodNameyesstring -
methodUnityesstring -
totalFlowsyesinteger -

FlowCFEntry

Type: object

PropertyRequiredTypeDescription
cfFlowNamenostring -
cfValuenonumber -
flowCategoryyesstring -
flowIdyesUUID -
flowNameyesstring -
matchStrategynostring -

CollectionCoverage

Type: object

PropertyRequiredTypeDescription
characterizedFlowsyesinteger -
collectionyesstring -
dbNameyesstring -
totalFlowsyesinteger -

CharacterizationResult

Type: object

PropertyRequiredTypeDescription
factorsyesCharacterizationEntry[] -
matchesyesinteger -
methodyesstring -
shownyesinteger -
unityesstring -

CharacterizationEntry

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
cfUnityesstring -
cfValueyesnumber -
compartmentnostring -
dbFlowNameyesstring -
directionyesstring -
flowIdyesstring -
flowUnityesstring -
matchStrategyyesstring -
methodFlowNameyesstring -

SearchResults_FlowSearchResult

Type: object

PropertyRequiredTypeDescription
hasMoreyesboolean -
limityesinteger -
offsetyesinteger -
resultsyesFlowSearchResult[] -
searchTimeMsyesnumber -
totalyesinteger -

FlowSearchResult

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
compartmentnostring -
idyesUUID -
kindyesExchangeKind -
nameyesstring -
producerCountnointeger -
synonymsyesobject -
unitNameyesstring -

SearchCountsAPI

Type: object

PropertyRequiredTypeDescription
flowsyesinteger -
processesyesinteger -
productsyesinteger -

SearchResults_ActivitySummary

Type: object

PropertyRequiredTypeDescription
hasMoreyesboolean -
limityesinteger -
offsetyesinteger -
resultsyesActivitySummary[] -
searchTimeMsyesnumber -
totalyesinteger -

ClassificationSystem

Type: object

PropertyRequiredTypeDescription
activityCountyesinteger -
nameyesstring -
valuesyesstring[] -

CataloguePage

Type: object

PropertyRequiredTypeDescription
entriesyesCatalogueEntry[] -
fingerprintyesstring -
offsetyesinteger -
totalyesinteger -

CatalogueEntry

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
classificationyesobject -
locationyesstring -
measurenoCatalogueMeasure -
processIdyesstring -
productAmountnonumber -
productNameyesstring -
unityesstring -

CatalogueMeasure

Type: object

PropertyRequiredTypeDescription
dimensionyesinteger[] -
factoryesnumber -

CatalogueFingerprint

Type: object

PropertyRequiredTypeDescription
fingerprintyesstring -

DatabaseComparison

Type: object

PropertyRequiredTypeDescription
addedyesActivitySummary[] -
addedCountyesinteger -
ambiguousyesAmbiguousActivities[] -
ambiguousCountyesinteger -
changedyesChangedActivity[] -
changedCountyesinteger -
redatedyesChangedActivity[] -
redatedCountyesinteger -
removedyesActivitySummary[] -
removedCountyesinteger -
unchangedyesPairedActivities[] -
unchangedCountyesinteger -

ChangedActivity

Type: object

PropertyRequiredTypeDescription
comparisonyesActivityComparison -
matchyesActivityMatch -

ActivityMatch

Type: string

Allowed values: SameProcessId, SameNames, SameProduct, SameCutNames

AmbiguousActivities

Type: object

PropertyRequiredTypeDescription
baseyesActivitySummary[] -
matchyesActivityMatch -
otheryesActivitySummary[] -

PairedActivities

Type: object

PropertyRequiredTypeDescription
baseyesActivitySummary -
matchyesActivityMatch -
otheryesActivitySummary -

ScorePairs

Type: object

PropertyRequiredTypeDescription
ambiguousCountyesinteger -
pairsyesScorePair[] -
setApartyesSetApartPair[] -
unpairedBaseCountyesinteger -
unpairedOtherCountyesinteger -

ScorePair

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
baseyesstring -
locationyesstring -
matchyesActivityMatch -
otheryesstring -
perBaseUnityesnumber -

SetApartPair

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
baseyesstring -
locationyesstring -
otheryesstring -
reasonyesPairRefusal -

PairRefusal

Type: oneOf(object | object | object | object | object | object)

ScoreUnits

Type: object

PropertyRequiredTypeDescription
invalidyesstring[] -
notFoundyesstring[] -
processesyesScoreUnit[] -
readingyesChosenUnit -
unityesstring -

ChosenUnit

Type: oneOf(object | object)

ScoreUnit

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
locationyesstring -
processIdyesstring -
productUnitnostring -
scaleyesUnitScale -

UnitScale

Type: oneOf(object | object)

ScoreUnitsRequest

Type: object

PropertyRequiredTypeDescription
processIdsyesstring[] -
unityesstring -

BatchImpactsResponse

Type: object

PropertyRequiredTypeDescription
basisyesScoreBasis -
invalidyesstring[] -
notFoundyesstring[] -
readingNoticenostring -
resultsyesBatchImpactsEntry[] -
unscorableyesstring[] -
unsolvableyesUnsolvableEntry[] -

BatchImpactsEntry

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
impactsyesLCIABatchResult -
parameterSetnointeger -
processIdyesstring -
productAmountnonumber -
productUnitnostring -

UnsolvableEntry

Type: object

PropertyRequiredTypeDescription
parameterSetnointeger -
processIdyesstring -
reasonyesstring -

BatchImpactsRequest

Type: object

PropertyRequiredTypeDescription
parameterSetsnoParameterValue[][] -
processIdsyesstring[] -

DatabaseListResponse

Type: object

PropertyRequiredTypeDescription
databasesyesDatabaseStatusAPI[] -

DatabaseStatusAPI

Type: object

PropertyRequiredTypeDescription
activityCountyesinteger -
addednostring -
allocationyesstring -
dependsOnyesstring[] -
descriptionnostring -
displayNameyesstring -
formatnostring -
isUploadedyesboolean -
licenceyesLicence -
loadAtStartupyesboolean -
modificationyesModification -
nameyesstring -
pathyesstring -
releasenoRelease -
sourcenostring -
statusyesstring -
systemModelnoModelTitle -

ModelTitle

Type: object

PropertyRequiredTypeDescription
nameyesstring -
versionyesstring -

Licence

Type: object

PropertyRequiredTypeDescription
acceptyesboolean -
acceptancenostring -
attributionyesboolean -
conditionsyesstring[] -
idnostring -
kindyesLicenceKind -
namenostring -
permissionsyesPermissionState[] -
refusedyesPermission[] -
textnostring -
urlnostring -
usagenoDisclosure -

LicenceKind

Type: string

Allowed values: unstated, standard, own

Permission

Type: string

Allowed values: inventory, scores, download, results, resell, paid-applications

PermissionState

Type: object

PropertyRequiredTypeDescription
enforcedyesboolean -
grantedyesboolean -
permissionyesPermission -

Disclosure

Type: string

Allowed values: anonymous, organizations

Modification

Type: object

PropertyRequiredTypeDescription
editedyesboolean -
reallocatedyesboolean -

LoadDatabaseResponse

Type: object

PropertyRequiredTypeDescription
databaseyesDatabaseStatusAPI -
depsyesDepLoadResult[] -

DepLoadResult

Type: oneOf(object | object)

ActivateResponse

Type: object

PropertyRequiredTypeDescription
databasenoDatabaseStatusAPI -
messageyesstring -
successyesboolean -

RelinkResponse

Type: object

PropertyRequiredTypeDescription
crossDBLinksyesinteger -
dbNameyesstring -
dependsOnyesstring[] -
unresolvedAfteryesinteger -
unresolvedBeforeyesinteger -

RelinkRequest

Type: object

PropertyRequiredTypeDescription
depDbnostring -
mappingCsvnostring -

GapReportAPI

Type: object

PropertyRequiredTypeDescription
completenessyesnumber -
crossDBLinksyesinteger -
dbNameyesstring -
gapsyesGapEntryAPI[] -
internalLinksyesinteger -
totalInputsyesinteger -
unresolvedEdgesyesinteger -
unresolvedProductsyesinteger -

GapEntryAPI

Type: object

PropertyRequiredTypeDescription
consumersyesinteger -
demandSumyesnumber -
detailnostring -
edgesyesinteger -
locationyesstring -
nameyesstring -
reasonyesstring -
reasonsyesBlockerReason[] -
supplierActivitynostring -
topConsumersyesGapConsumerAPI[] -
unityesstring -

GapConsumerAPI

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
edgesyesinteger -
locationyesstring -
processIdyesstring -
productNameyesstring -

QualityReportAPI

Type: object

PropertyRequiredTypeDescription
allocationOutOfRangeyesQualityCheckAPI -
allocationSumsyesQualityCheckAPI -
dbNameyesstring -
duplicateActivitiesyesQualityCheckAPI -
duplicateProductsyesQualityCheckAPI -
formulaConsistencyyesQualityCheckAPI -
invalidCasyesQualityCheckAPI -
landTransformationBalanceyesQualityCheckAPI -
missingMetadatayesQualityCheckAPI -
missingPedigreeyesQualityCheckAPI -
obsoleteInputsyesQualityCheckAPI -
oxygenDemandOrderyesQualityCheckAPI -
processCountyesinteger -
referenceProductyesQualityCheckAPI -
suspiciousAmountsyesQualityCheckAPI -
truncatedNameCollisionsyesQualityCheckAPI -
unallocatedyesQualityCheckAPI -
unconsumedProductsyesQualityCheckAPI -
undeclaredGeographyyesQualityCheckAPI -
unmeasurableAmountsyesQualityCheckAPI -
unsuppliedInputsyesQualityCheckAPI -
waterBalanceyesQualityCheckAPI -

QualityCheckAPI

Type: object

PropertyRequiredTypeDescription
applicableyesboolean -
offenderCountyesinteger -
offendersyesQualityOffenderAPI[] -

QualityOffenderAPI

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
detailyesstring -
locationyesstring -
processIdyesstring -
productNamenostring -
severityyesSeverity -

Severity

Type: string

Allowed values: danger, warning, info

ComputedQualityReportAPI

Type: object

PropertyRequiredTypeDescription
collectionyesstring -
dbNameyesstring -
negativeScoresyesQualityCheckAPI -
processCountyesinteger -
scoreOutliersyesQualityCheckAPI -
unsolvableyesQualityCheckAPI -
zeroScoresyesQualityCheckAPI -

CoverageReportAPI

Type: object

PropertyRequiredTypeDescription
collectionsyesCollectionBridgesAPI[] -
dbNameyesstring -

CollectionBridgesAPI

Type: object

PropertyRequiredTypeDescription
bridgeGroupCountyesinteger -
bridgeGroupsyesBridgeGroupAPI[] -
characterizedFlowsyesinteger -
collectionyesstring -
totalFlowsyesinteger -

BridgeGroupAPI

Type: object

PropertyRequiredTypeDescription
bridgedFlowsyesBridgedFlowAPI[] -
casnostring -
methodNameyesstring -

BridgedFlowAPI

Type: object

PropertyRequiredTypeDescription
flowNameyesstring -
strategyyesstring -

DeriveRequest

Type: object

PropertyRequiredTypeDescription
parentnoboolean -
systemModelnostring -

SystemModelAPI

Type: object

PropertyRequiredTypeDescription
exceptionsyesModelExceptionAPI[] -
parametersyesModelParameterAPI[] -
substitutionsyesModelSubstitutionAPI[] -
textyesstring -

ModelExceptionAPI

Type: object

PropertyRequiredTypeDescription
keyyesstring -
processesyesTakenProcessAPI[] -
reasonyesstring -

TakenProcessAPI

Type: object

PropertyRequiredTypeDescription
activityyesstring -
nameyesstring -

ModelSubstitutionAPI

Type: object

PropertyRequiredTypeDescription
blockyesstring -
coproductyesstring -
coproductNameyesstring -
ratioyesnumber -
reasonyesstring -
replacedProcessyesstring -
replacedProductyesstring -
replacesyesstring -

ModelParameterAPI

Type: object

PropertyRequiredTypeDescription
nameyesstring -
processesyesTakenProcessAPI[] -
reasonyesstring -
valueyesnumber -

DeleteSelectionResponse

Type: object

PropertyRequiredTypeDescription
deletedyesinteger -
messageyesstring -
successyesboolean -
transientyesboolean -
warningsyesstring[] -

DeleteSelectionRequest

Type: object

PropertyRequiredTypeDescription
classificationsyesDeleteClassFilter[] -
exactnoboolean -
extrayesstring[] -
idsnostring[] -
keepyesstring[] -
locationnostring -
namenostring -
notenostring -
productnostring -
sourcenoSource -

DeleteClassFilter

Type: object

PropertyRequiredTypeDescription
exactyesboolean -
systemyesstring -
valueyesstring -

ActivityWriteResponse

Type: object

PropertyRequiredTypeDescription
transientyesboolean -
warningsyesstring[] -
writtenyesstring[] -

ActivityWriteRequest

Type: object

PropertyRequiredTypeDescription
activitiesyesActivityInput[] -
notenostring -
sourcenoSource -

ActivityInput

Type: object

PropertyRequiredTypeDescription
biosphereyesBioExchangeAPI[] -
descriptionyesstring[] -
inputsyesTechInputAPI[] -
locationyesstring -
nameyesstring -
productAmountyesnumber -
productNameyesstring -
productUnityesstring -
wasteOutputsyesWasteOutputAPI[] -

TechInputAPI

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
commentnostring -
provideryesstring -
unitnostring -

BioExchangeAPI

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
commentnostring -
compartmentnostring -
directionyesstring -
flownostring -
namenostring -
subCompartmentnostring -
unitnostring -

WasteOutputAPI

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
commentnostring -
provideryesstring -
unitnostring -

ExchangeEditResponse

Type: object

PropertyRequiredTypeDescription
addedyesinteger -
amountsSetyesinteger[] -
dryMassesSetyesinteger[] -
formulasSetyesinteger[] -
parametersRemovedyesstring[] -
parametersSetyesstring[] -
pricesSetyesinteger[] -
removedyesinteger[] -
restatedyesRestatedLineAPI[] -
suppliersSetyesinteger[] -
textsSetyesstring[] -
transientyesboolean -
warningsyesstring[] -
wetMassesSetyesinteger[] -

RestatedLineAPI

Type: object

PropertyRequiredTypeDescription
fromyesnumber -
positionyesinteger -
toyesnumber -

ExchangeEditRequest

Type: object

PropertyRequiredTypeDescription
addBiosphereyesBioExchangeAPI[] -
addInputsyesTechInputAPI[] -
addWasteOutputsyesWasteOutputAPI[] -
notenostring -
removeyesExchangeSelectorAPI[] -
removeParametersyesstring[] -
setAmountsyesSetAmountAPI[] -
setDescriptionnostring[] -
setDryMassesyesSetDryMassAPI[] -
setFormulasyesSetFormulaAPI[] -
setLocationnostring -
setNamenostring -
setParametersyesSetParameterAPI[] -
setPricesyesSetPriceAPI[] -
setSuppliersyesSetSupplierAPI[] -
setWetMassesyesSetWetMassAPI[] -
sourcenoSource -

SetAmountAPI

Type: object

PropertyRequiredTypeDescription
amountyesnumber -
selectyesExchangeSelectorAPI -

SetParameterAPI

Type: object

PropertyRequiredTypeDescription
descriptionnostring -
formulanostring -
nameyesstring -
uncertaintynoUncertainty -
unitnostring -
valuenonumber -

SetFormulaAPI

Type: object

PropertyRequiredTypeDescription
formulanostring -
selectyesExchangeSelectorAPI -

SetPriceAPI

Type: object

PropertyRequiredTypeDescription
pricenoStatedAmount -
productyesstring -

SetDryMassAPI

Type: object

PropertyRequiredTypeDescription
dryMassnoStatedAmount -
productyesstring -

SetWetMassAPI

Type: object

PropertyRequiredTypeDescription
productyesstring -
wetMassnoStatedAmount -

SetSupplierAPI

Type: object

PropertyRequiredTypeDescription
provideryesstring -
selectyesExchangeSelectorAPI -

ActivitiesEditResponse

Type: object

PropertyRequiredTypeDescription
editedyesExchangeEditResponse[] -
transientyesboolean -
warningsyesstring[] -

ActivitiesEditRequest

Type: object

PropertyRequiredTypeDescription
editsyesActivityEditAPI[] -
notenostring -
sourcenoSource -

ActivityEditAPI

Type: object

PropertyRequiredTypeDescription
addBiosphereyesBioExchangeAPI[] -
addInputsyesTechInputAPI[] -
addWasteOutputsyesWasteOutputAPI[] -
processIdyesstring -
removeyesExchangeSelectorAPI[] -
removeParametersyesstring[] -
setAmountsyesSetAmountAPI[] -
setDescriptionnostring[] -
setDryMassesyesSetDryMassAPI[] -
setFormulasyesSetFormulaAPI[] -
setLocationnostring -
setNamenostring -
setParametersyesSetParameterAPI[] -
setPricesyesSetPriceAPI[] -
setSuppliersyesSetSupplierAPI[] -
setWetMassesyesSetWetMassAPI[] -

SupplyMissingRequest

Type: object

PropertyRequiredTypeDescription
notenostring -
productyesstring -
provideryesstring -
sourcenoSource -
supplierActivitynostring -

OctetStream

Type: string

DatabaseExportRequest

Type: object

PropertyRequiredTypeDescription
formatyesstring -
packagenostring -

DatabaseSetupInfo

Type: object

PropertyRequiredTypeDescription
activityCountyesinteger -
attributeFallbacksyesAttributeFallback[] -
availablePathsyesPathCandidate[] -
completenessyesnumber -
crossDBLinksyesinteger -
dataPathyesstring -
dependenciesyesDependencyChoice[] -
displayNameyesstring -
documentationyesDatabaseDocumentation -
inputCountyesinteger -
internalLinksyesinteger -
isLoadedyesboolean -
isReadyyesboolean -
licenceyesLicence -
locationFallbacksyesLocationFallback[] -
locationUnresolvedyesLocationUnresolved[] -
missingSuppliersyesMissingSupplier[] -
nameyesstring -
releasenoRelease -
requiredReleasesyesRequiredRelease[] -
supplierAmbiguitiesyesSupplierAmbiguity[] -
systemModelsyesstring[] -
unknownUnitsyesstring[] -
unresolvedLinksyesinteger -

MissingSupplier

Type: object

PropertyRequiredTypeDescription
countyesinteger -
detailnostring -
locationnostring -
locationsyesstring[] -
productNameyesstring -
reasonyesstring -
supplierActivitynostring -

DependencyChoice

Type: object

PropertyRequiredTypeDescription
databaseNameyesstring -
displayNameyesstring -
matchCountyesinteger -
statusyesDependencyStatus -

DependencyStatus

Type: string

Allowed values: selected, available, redundant

LocationFallback

Type: object

PropertyRequiredTypeDescription
actualyesstring -
kindyesLocationKind -
productyesstring -
requestedyesstring -

LocationKind

Type: string

Allowed values: exact, parent, global, unrelated

LocationUnresolved

Type: object

PropertyRequiredTypeDescription
productyesstring -
reasonyesstring -
requestedyesstring -

AttributeFallback

Type: object

PropertyRequiredTypeDescription
matchedyesstring -
productyesstring -
requestedyesstring -
sourceDatabaseyesstring -

SupplierAmbiguity

Type: object

PropertyRequiredTypeDescription
candidatesyesinteger -
chosenyesstring -
productyesstring -
requestedyesstring -
sourceDatabaseyesstring -

PathCandidate

Type: object

PropertyRequiredTypeDescription
fileCountyesinteger -
formatyesstring -
pathyesstring -

DatabaseDocumentation

Type: object

PropertyRequiredTypeDescription
exportnoExportStamp -
literatureyesLibraryDocument[] -
systemsyesLibraryDocument[] -

ExportStamp

Type: object

PropertyRequiredTypeDescription
datenoDay -
formatVersionnostring -
projectnostring -
timenoTimeOfDay -
toolyesstring -

TimeOfDay

Type: string

LibraryDocument

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
filesyesstring[] -
nameyesstring -
sectionsyesDocSection[] -

RequiredRelease

Type: object

PropertyRequiredTypeDescription
databasesyesstring[] -
releaseyesRelease -
stateyesSatisfaction -

Satisfaction

Type: string

Allowed values: satisfied, substituted, missing

ReleaseSubstitution

Type: object

PropertyRequiredTypeDescription
databaseyesstring -
releaseyesRelease -

UploadResponse

Type: object

PropertyRequiredTypeDescription
droppednoDroppedFactors -
familiesyesUploadedFamily[] -
formatnostring -
messageyesstring -
slugnostring -
successyesboolean -

UploadedFamily

Type: object

PropertyRequiredTypeDescription
factorsyesinteger -
nameyesstring -
slugyesstring -

DroppedFactors

Type: object

PropertyRequiredTypeDescription
countyesinteger -
examplesyesstring[] -

UploadChunk

Type: string

MethodCollectionListResponse

Type: object

PropertyRequiredTypeDescription
defaultnostring -
methodsyesMethodCollectionStatusAPI[] -

MethodCollectionStatusAPI

Type: object

PropertyRequiredTypeDescription
addednostring -
descriptionnostring -
displayNameyesstring -
formatnostring -
isUploadedyesboolean -
methodCountyesinteger -
nameyesstring -
pathyesstring -
sourcenostring -
statusyesstring -

AvailableMethodCollection

Type: object

PropertyRequiredTypeDescription
descriptionyesstring -
installedyesboolean -
licencenostring -
nameyesstring -
publisheryesstring -
sizeyesinteger -
sourceUrlyesstring -
versionyesstring -

ExportRequest

Type: object

PropertyRequiredTypeDescription
formatyesstring -

MethodCollectionComparison

Type: object

PropertyRequiredTypeDescription
ambiguousyesAmbiguousCategories[] -
categoriesyesCategoryComparison[] -
unpairedBaseyesCategorySide[] -
unpairedOtheryesCategorySide[] -

CategoryComparison

Type: object

PropertyRequiredTypeDescription
addedyesFactorSide[] -
addedCountyesinteger -
ambiguousyesAmbiguousFactors[] -
ambiguousCountyesinteger -
baseyesCategorySide -
changedyesChangedFactor[] -
changedCountyesinteger -
largestRationonumber -
matchyesCategoryMatch -
otheryesCategorySide -
removedyesFactorSide[] -
removedCountyesinteger -
unchangedCountyesinteger -
unconvertibleyesUnconvertibleFactor[] -
unconvertibleCountyesinteger -

CategoryMatch

Type: string

Allowed values: ForcedByCaller, SameMethodName, SameImpactCategory

CategorySide

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
factorCountyesinteger -
methodIdyesUUID -
nameyesstring -
unityesstring -

FactorSide

Type: object

PropertyRequiredTypeDescription
casnostring -
compartmentyesstring -
directionyesFlowDirection -
flowNameyesstring -
flowRefyesUUID -
locationnostring -
unitnostring -
valueyesnumber -

FlowDirection

Type: string

Allowed values: Input, Output

ChangedFactor

Type: object

PropertyRequiredTypeDescription
baseyesFactorSide -
matchyesFactorMatch -
otheryesFactorSide -
rationonumber -
readingyesValueReading -

FactorMatch

Type: string

Allowed values: SameFlowId, SameName, SameSynonymClass, SameCAS, SamePattern

ValueReading

Type: string

Allowed values: UnitsIdentical, ConvertedOntoBaseUnit, ReadPerReferenceUnit, ComparedAsWritten

AmbiguousFactors

Type: object

PropertyRequiredTypeDescription
baseyesFactorSide[] -
matchyesFactorMatch -
otheryesFactorSide[] -

UnconvertibleFactor

Type: object

PropertyRequiredTypeDescription
baseyesFactorSide -
matchyesFactorMatch -
otheryesFactorSide -

AmbiguousCategories

Type: object

PropertyRequiredTypeDescription
baseyesCategorySide[] -
matchyesCategoryMatch -
otheryesCategorySide[] -

MethodCollectionProfile

Type: object

PropertyRequiredTypeDescription
categoriesyesCategoryProfile[] -

CategoryProfile

Type: object

PropertyRequiredTypeDescription
categoryyesCategorySide -
duplicatesyesDuplicateFactors[] -
locatedCountyesinteger -
locatedInNameCountyesinteger -
locationCountyesinteger -
mediayesMediumCount[] -
patternCountyesinteger -
zeroCountyesinteger -

MediumCount

Type: object

PropertyRequiredTypeDescription
factorCountyesinteger -
mediumnostring -

DuplicateFactors

Type: object

PropertyRequiredTypeDescription
factorsyesFactorSide[] -
matchyesFactorMatch -

MethodEditResponse

Type: object

PropertyRequiredTypeDescription
afternonumber -
beforenonumber -
lineyesinteger -
methodIdnoUUID -
touchedyesinteger -

FactorEditRequest

Type: object

PropertyRequiredTypeDescription
factornoNewFactorAPI -
flowIdnoUUID -
locationnostring -
matchnoFactorMatchAPI -
methodIdnoUUID -
newValuenonumber -
opyesFactorEditOp -
scalenonumber -
valuenonumber -

FactorEditOp

Type: string

Allowed values: set, remove, add, scale, set-all

FactorMatchAPI

Type: object

PropertyRequiredTypeDescription
casnostring -
categorynostring -
flowNamenostring -
flowNamePrefixnostring -
subcompartmentContainsnostring -

NewFactorAPI

Type: object

PropertyRequiredTypeDescription
casnostring -
compartmentnoCompartmentAPI -
directionyesFlowDirection -
flowIdyesUUID -
locationnostring -
nameyesstring -
unityesstring -
valueyesnumber -

CompartmentAPI

Type: object

PropertyRequiredTypeDescription
mediumyesstring -
qualifieryesstring -
subcompartmentyesstring -

CategoryEditRequest

Type: object

PropertyRequiredTypeDescription
impactCategorynostring -
methodIdnoUUID -
methodologynostring -
namenostring -
opyesCategoryEditOp -
unitnostring -

CategoryEditOp

Type: string

Allowed values: add, rename, set-unit, remove

ScoringSetAPI

Type: object

PropertyRequiredTypeDescription
displayMultipliernonumber -
nameyesstring -
rowsyesScoringRowAPI[] -
scoresyesScoreAPI[] -
unityesstring -
variablesyesobject -
weighsyesboolean -

ScoringRowAPI

Type: object

PropertyRequiredTypeDescription
labelyesstring -
normalizationnoExact -
termsyesRowTermsAPI -
unitnostring -
variableyesstring -
weightnonumber -

RowTermsAPI

Type: oneOf(object | object)

RowTermAPI

Type: object

PropertyRequiredTypeDescription
categoryyesstring -
coefficientyesnumber -
methodIdnoUUID -

Exact

Type: oneOf(number | string)

ScoreAPI

Type: object

PropertyRequiredTypeDescription
formulayesstring -
nameyesstring -
sumOfRowsyesboolean -

ScoringEditRequest

Type: object

PropertyRequiredTypeDescription
formulanostring -
multipliernonumber -
namenostring -
opyesScoringEditOp -
rownoRowDraftAPI -
rowsnoRowDraftAPI[] -
scorenostring -
setyesstring -
unitnostring -
variablenostring -

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

PropertyRequiredTypeDescription
labelyesstring -
normalizationnoExact -
termsyesDraftTermAPI[] -
unitnostring -
weightnonumber -

DraftTermAPI

Type: object

PropertyRequiredTypeDescription
coefficientyesnumber -
methodIdyesUUID -

MethodHistoryEntry

Type: object

PropertyRequiredTypeDescription
atyesstring -
bynostring -
changeyesMethodChangeAPI -
inEffectyesboolean -
kindyesHistoryKindAPI -
lineyesinteger -
undoesnointeger -
vianostring -

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

PropertyRequiredTypeDescription
casnostring -
compartmentnoCompartmentAPI -
directionyesFlowDirection -
flowIdyesUUID -
nameyesstring -
unityesstring -

RefDataListResponse

Type: object

PropertyRequiredTypeDescription
itemsyesRefDataStatusAPI[] -

RefDataStatusAPI

Type: object

PropertyRequiredTypeDescription
addednostring -
descriptionnostring -
displayNameyesstring -
entryCountyesinteger -
isAutoyesboolean -
isUploadedyesboolean -
nameyesstring -
statusyesstring -

SynonymGroupsResponse

Type: object

PropertyRequiredTypeDescription
groupsyesstring[][] -

RefDataRowsResponse

Type: object

PropertyRequiredTypeDescription
headeryesstring[] -
rowsyesstring[][] -

UsagePage

Type: object

PropertyRequiredTypeDescription
bootyesstring -
linesyesUsageLine[] -
moreyesboolean -

UsageLine

Type: object

PropertyRequiredTypeDescription
atyesUTCTime -
countedyesCountedRelease[] -
databaseyesstring -
heldAsnoProcessNaming -
kindyesUsageKind -
processyesstring -
readernostring -
seqyesinteger -

UTCTime

Type: string

UsageKind

Type: string

Allowed values: reading, inventory, scoring, contributions, comparison

ProcessNaming

Type: object

PropertyRequiredTypeDescription
activityNameyesstring -
locationyesstring -
productNamenostring -

CountedRelease

Type: object

PropertyRequiredTypeDescription
disclosureyesDisclosure -
releaseyesRelease -

LoginRequest

Type: object

PropertyRequiredTypeDescription
lrCodeyesstring -

ClassificationPresetInfo

Type: object

PropertyRequiredTypeDescription
descriptionnostring -
filtersyesClassificationEntryInfo[] -
labelyesstring -
nameyesstring -

ClassificationEntryInfo

Type: object

PropertyRequiredTypeDescription
modeyesstring -
systemyesstring -
valueyesstring -

FormulaLanguage

Type: object

PropertyRequiredTypeDescription
functionsyesFormulaFunction[] -
operatorsyesstring[][] -
rulesyesstring[] -

FormulaFunction

Type: object

PropertyRequiredTypeDescription
exampleyesstring -
formyesstring -
meaningyesstring -
nameyesstring -
usageyesstring -
valueyesnumber -

FormulaCheckResponse

Type: object

PropertyRequiredTypeDescription
problemnostring -
readsyesstring[] -
valuenonumber -
warningsyesstring[] -

FormulaCheckRequest

Type: object

PropertyRequiredTypeDescription
exchangenointeger -
formulayesstring -
processnostring -

DatabaseHistoryEntry

Type: object

PropertyRequiredTypeDescription
atyesstring -
bynostring -
databaseyesstring -
detailsyesstring[] -
notenostring -
sourcenoSource -
summaryyesstring -
vianostring -

ParametersEditResponse

Type: object

PropertyRequiredTypeDescription
parametersRemovedyesstring[] -
parametersSetyesstring[] -
restatedProcessesyesstring[] -
transientyesboolean -
warningsyesstring[] -

ParametersEditRequest

Type: object

PropertyRequiredTypeDescription
notenostring -
removeParametersyesstring[] -
setParametersyesSetParameterAPI[] -
sourcenoSource -

ScenarioAPI

Type: object

PropertyRequiredTypeDescription
nameyesstring -
parametersyesParameterValue[] -
problemnostring -
shippedyesboolean -

ScenarioSaveRequest

Type: object

PropertyRequiredTypeDescription
parametersyesParameterValue[] -