GetGwpInventoryConstitute - Energy Expert - Alibaba Cloud Documentation Center

Used to obtain the carbon emission composition analysis of a specified product. Carbon emission composition analysis includes two analysis dimensions: inventory and type. In the rendering effect, including a hierarchical list and pie chart.

Operation description

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/carbon/footprint/result/gwp/inventory/constitute

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request parameters.
code	string	Yes	The enterprise code.	C-20080808-1
productId	long	Yes	The product id.	1024
productType	long	Yes	Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.	1

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.	06DA2909-7736-5738-AA31-ACD617D828F1
data	object	The response parameters.
name	string	The name.	This is not used for displaying
unit	string	Emission Unit.	kgCO₂e/t
carbonEmission	double	Emission quantity: may be positive, negative, or 0. To ensure the calculation accuracy, 24 decimal places are reserved for the calculation process. We recommend that you intercept data based on your business requirements.	1009.976265540000000000000000000000
byResourceType	array	Aggregated by resource type of an inventory.
	GwpInventoryConstitute	Used for "by type" analysis in composition analysis. This is a nested structure, total carbon emissions-> sorted by inventory type, a total of two layers, the last level byResource is empty.
items	array	Organized by hierarchy from high to low, according to the flow-> process-> inventory hierarchy.
	GwpInventoryConstitute	Used for "by inventory" analysis in composition analysis. Is a nested structure, according to the link-> operation-> list level, the last level items is empty .

Examples

Sample success responses

JSONformat

{
  "requestId": "06DA2909-7736-5738-AA31-ACD617D828F1",
  "data": {
    "name": "This is not used for displaying",
    "unit": "kgCO₂e/t",
    "carbonEmission": 1009.97626554,
    "byResourceType": [
      {
        "percent": 100,
        "resourceType": 1,
        "unit": "kgCO₂e/kg",
        "carbonEmission": 1009.97626554,
        "name": "Acquisition of Raw Materials",
        "byResourceType": [
          {
            "name": "Energy",
            "unit": "kgCO₂e/Piece(s)",
            "resourceType": 1,
            "carbonEmission": 1009.97626554,
            "percent": "98.76"
          }
        ],
        "items": [
          {
            "percent": 100,
            "resourceType": 1,
            "unit": "kgCO₂e/kg",
            "carbonEmission": 1009.97626554,
            "name": "Acquisition of Raw Materials",
            "byResourceType": [
              {
                "name": "Energy",
                "unit": "kgCO₂e/Piece(s)",
                "resourceType": 1,
                "carbonEmission": 1009.97626554,
                "percent": "98.76"
              }
            ],
            "items": [
              {
                "percent": 100,
                "resourceType": 1,
                "unit": "kgCO₂e/kg",
                "carbonEmission": 1009.97626554,
                "name": "Acquisition of Raw Materials",
                "byResourceType": [
                  {
                    "name": "Energy",
                    "unit": "kgCO₂e/Piece(s)",
                    "resourceType": 1,
                    "carbonEmission": 1009.97626554,
                    "percent": "98.76"
                  }
                ],
                "items": []
              }
            ]
          }
        ]
      }
    ],
    "items": []
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-01	The response structure of the API has changed	View Change Details