本接口用于获得产品碳足迹总量,以及碳足迹贡献占比的Top4类型详情。
接口说明
用户指产品 id,本接口返回获得已经生成结果页中的碳足迹总量数据,以及碳足迹贡献占比的 Top4 类型详情。可用于了解产品碳足迹总量和主要来源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
energy:GetGwpInventorySummary |
none |
*全部资源
|
无 | 无 |
请求语法
POST /api/v1/carbon/footprint/result/gwp/inventory/summary HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求参数。 |
|
| code |
string |
是 |
企业编码。 |
C-20080808-1 |
| productId |
integer |
是 |
产品 id。 |
1024 |
| productType |
integer |
是 |
产品类型:1 表示请求产品碳足迹,5 表示请求供应链碳足迹。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 id,每次请求都是唯一值,便于后续排查问题。 |
83A5A7DD-8974-5769-952E-590A97BEA34E |
| data |
object |
返回结果。 |
|
| unit |
string |
排放单位。 |
tCO₂e/Piece(s) |
| quantity |
number |
数量。 |
1.0100 |
| resultGenerateTime |
integer |
计算结果生成时间,格式为毫秒时间戳。 |
1709108026000 |
| items |
array<object> |
碳足迹贡献占比的 Top4 类型详情。 |
|
|
object |
|||
| name |
string |
清单类型名。 |
电力清单 |
| unit |
string |
单位。 |
kgCO₂e/Piece(s) |
| quantity |
number |
数量。 |
9.9763 |
| percent |
string |
所占百分比。 |
99.01 |
示例
正常返回示例
JSON格式
{
"requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
"data": {
"unit": "tCO₂e/Piece(s)",
"quantity": 1.01,
"resultGenerateTime": 1709108026000,
"items": [
{
"name": "电力清单",
"unit": "kgCO₂e/Piece(s)",
"quantity": 9.9763,
"percent": "99.01"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。