GetGwpBenchmarkSummary - 获取主动减碳量总量

获取主动减碳量总量。

接口说明

用户指产品 id,本接口返回获得已经生成结果页中的主动减碳量数据,以及减碳量贡献 top4 详情。可用于了解产品主动减碳量总量和主要来源。

调试

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

授权信息

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

请求语法

POST /api/v1/carbon/footprint/result/gwp/benchmark/summary HTTP/1.1

请求参数

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

请求参数。

codestring

企业编码。

C-20080808-1
productIdlong

产品 id。

1024
productTypelong

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

1

返回参数

名称类型描述示例值
object
requestIdstring

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

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

返回数据。

itemsarray<object>

减碳量贡献 top4 详情。

itemsobject

Item 详情。

namestring

减碳详情的名称。

原材料
percentstring

排放百分比。字符串类型,数字保留两位小数。例如 "99.01"表示该类排放占总排放的 99.01%,需要注意返回的字符串中本身不含百分号。

99.01
quantitylong

排放数量。数值保留四位小数,一般地,建模下该值不会出现负数,但是用户可以构造出主动减碳量为负数的值。quantity 和 unit 共同构成排放量,quantity 和 unit 会自适应。当排放量大于 1000kgCO₂e/productUnit 时,那么 quantity 和 unit 会转换为以 tCO₂e/productUnit 单位的数值;当排放量小于 1kgCO₂e/productUnit 时,那么 quantity 和 unit 会转换为以 gCO₂e/productUnit 单位的数值;其他情况下,quantity 保持 unit 为 kgCO₂e/productUnit 的数值。

9.9763
unitstring

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

kgCO₂e/kg
quantitylong

排放数量。数值保留四位小数,一般地,建模下该值不会出现负数,但是用户可以构造出主动减碳量为负数的值。quantity 和 unit 共同构成排放量,quantity 和 unit 会自适应。当排放量大于 1000kgCO₂e/productUnit 时,那么 quantity 和 unit 会转换为以 tCO₂e/productUnit 单位的数值;当排放量小于 1kgCO₂e/productUnit 时,那么 quantity 和 unit 会转换为以 gCO₂e/productUnit 单位的数值;其他情况下,quantity 保持 unit 为 kgCO₂e/productUnit 的数值。

1000.0000
unitstring

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

kgCO₂e/t

示例

正常返回示例

JSON格式

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "items": [
      {
        "name": "原材料",
        "percent": "99.01",
        "quantity": 9.9763,
        "unit": "kgCO₂e/kg"
      }
    ],
    "quantity": 1000,
    "unit": "kgCO₂e/t"
  }
}

错误码

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