文档

GetInventoryList - 获取排行列表

更新时间:

用于获取指定环境影响(methodType)、指定分组汇总级别(group)、指定计算方式下(emissionType)的降序排放列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/carbon/footprint/result/inventory/list

请求参数

名称类型必填描述示例值
bodyobject

请求参数。

codestring

企业编码。

C-20080808-1
productIdlong

产品 id。

1024
productTypelong

产品类型: 1 表示请求产品碳足迹,5 表示请求供应链碳足迹。

1
methodTypestring

获取的环境影响类型:gwp 为气候变化碳足迹,其他请见枚举值的 type 值,参考附录

gwp
emissionTypestring

排放类型

说明 可选值有:footprint | emission。含义:footprint:所有的清单都参与计算;emission:只有排放为正数和零的清单参与计算,负数不参与计算。
footprint
groupstring

分组依据

说明 可选值有:resource | process | resourceType | processType。含义:resource:按清单分组聚合,process:按工序分组聚合,resourceType:按清单类型分组聚合,processType:按环节分组聚合。
resource

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题。

83A5A7DD-8974-5769-952E-590A97BEA34E
dataobject

返回数据。

unitstring

排放单位:默认为 kgCO₂e/productUnit,productUnit 为产品选择的单位。随着排放数量 quantity 的大小不同,unit 会自适应转变为 tCO₂e/productUnit 或者 gCO₂e/productUnit,具体转换规则见 quantity 栏。

kgCO₂e/kg
productUnitstring

产品的单位。

kg
itemsobject []

排放列表详情。

namestring

名称

说明 与请求参数 group 有关。请求参数为:resource,返回 name 参数含义为:清单名称;请求参数为:process,返回 name 参数含义为:工序名称;请求参数为:resourceType,返回 name 参数含义为:清单类型名称;请求参数为:processType,返回 name 参数含义为:环节名称。
电力
carbonEmissiondouble

排放数量:可能为正数、负数、0。为保证计算精度,计算过程保留 24 位小数,为方便显示和使用,建议根据业务需要进行截取。

1000.000000000000000000000000000000
percentstring

百分比。

99.01
processNamestring

工序名称:仅对于请求参数 group 为 resource 时候有意义,其他时候无意义。

Process-1

示例

正常返回示例

JSON格式

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "unit": "kgCO₂e/kg",
    "productUnit": "kg",
    "items": [
      {
        "name": "电力",
        "carbonEmission": 1000,
        "percent": "99.01",
        "processName": "Process-1"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈