Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

HEX Core Integration

Input and Output Models

The service uses these CE-RISE data models:

RecordData ModelValidation
product_systemProduct SystemBefore foreground construction.
Each entry in lci_datasetsLCI DatasetBefore foreground construction.
Generated resultIntegrated LCAAfter calculation, before returning the result.

model_versions specifies the schema versions registered in HEX Core. These are distinct from the versions assigned to individual input records.

Validation Requests

Both compute endpoints check the Product System and each LCI Dataset against the versions named in model_versions. After a successful calculation, POST /compute also validates its generated Integrated LCA object against model_versions.integrated_lca. For each record, the service first requests the JSON Schema artifact from HEX Core and then calls:

GET /models/{model-family}/versions/{version}/schema
POST /models/{model-family}/versions/{version}:validate

The validation request body is a JSON object whose payload field contains the record.

The validation report must include a JSON Schema result for the requested model version. Failed input validation returns 422 with HEX Core’s findings. Failed output validation returns 500, and the generated result is not returned. An unavailable schema or HEX Core returns 503; a malformed report returns 502. After input validation, the service checks reference-flow links and assembles the inventory.

Connection and Authentication

Set HEX_CORE_BASE_URL to the running HEX Core service. If it requires bearer-token authentication, provide HEX_CORE_BEARER_TOKEN through deployment secrets. The token is sent only to HEX Core and is not included in the health response.

See Deployment for connection settings and the API Reference for validation error codes.