跳至正文
HiQLCD支持中心

数据查询 API

请求约定

网关路径前缀为 /api/relic。以下 POST 端点均执行读取请求。

字段定义
Accept-Version请求头,当前契约版本为 1
datasetRef服务生成的不透明数据集句柄
page.cursor续页游标,对应上一页响应中的 page.cursor
page.limit每页条数

接口

方法与路径内容
POST /api/relic/search按活动聚合的检索结果与数据集摘要
POST /api/relic/lookup批量数据集详情
GET /api/relic/sources数据源、版本与系统模型目录
POST /api/relic/lci某数据集的累积基本流清单
POST /api/relic/lcia某数据集的 LCIA 结果
POST /api/relic/lcia-methods指定数据源与版本的 LCIA 方法目录

检索字段

/search 请求字段定义
query参考产品、名称或描述关键词,可省略
filters.sources数据源及版本范围
filters.models系统模型范围
filters.locations地理代码范围
filters.activityTypes活动类型范围
filters.classifications分类范围
sortname 或 relevance;相关性排序要求 query 非空
page游标及每页条数,每页最多 100 条

字段之间按 AND 组合,同一字段的多值按 OR 匹配。data 为活动数组,datasets 为对应数据集摘要,page.total 为命中活动数。

详情字段

/lookup 请求字段定义
datasetRefs数据集句柄数组,与 coordinates 二选一
coordinates坐标数组;每项包含 id、version、systemModel
includedocumentation、provenance;默认包含二者

每次最多查询 200 项。未找到的记录返回 found: false。

下表为数据集详情中的地理与参考产品字段;XLSX 对应列见 Geographies 和模型目录列。

/lookup 响应字段定义
location.id数据集地理标识
location.name地理名称
location.path已有地理路径,可为空
referenceProduct.amount参考产品数量
referenceProduct.unit参考产品单位

结果字段

接口主要请求字段主要响应字段
/lcidatasetRef;可选 type、name、flowCategory、pageflow、amount、unit、direction
/lciadatasetRef;可选 methodId、categories、indicators、pagemethod、value、unit
/lcia-methodssource;可选 version、query、pagedata.methods 中的 methodId、name、category、indicator、unit、version
查询每页上限结果范围
/lci200累积基本流,不含参考产品;单位缺失时为 null
/lcia200影响评价方法、影响类别和类别指标对应的结果
/lcia-methods500数据源与版本对应的影响评价方法目录

累积 LCI 的 amount / unit 表示基本流数量与计量单位;LCIA 的 value / unit 表示影响评价结果与类别指标单位。

/lcia 的 methodId、categories、indicators 取值来自相应数据源的方法目录。methodId 使用完整的 Method ID,不是单独的 Method UUID。

响应

字段内容
data查询数据,结构随端点而不同
pagecursor、limit、total;cursor 为空表示没有后续页
meta契约版本、语言与发布集元数据
restricted/lci、/lcia 的结果受限标志
data.restricted/lcia-methods 的目录受限标志
errorcode、message、field、details、requestId

商业数据未授权时,/lci、/lcia 返回空 data 及 restricted: true;/lcia-methods 返回空 methods 及 data.restricted: true。查询接口不返回单元过程直接交换、供应份额或特征化因子数值表。