GetEpdInventoryConstitute - Energy Expert - Alibaba Cloud Documentation Center

Operation description

This API returns emission amounts for a product, broken down by environmental impact type and level. The data is sourced from the results page. You can use this API to retrieve the emission quantity for each checklist item.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

energy:GetEpdInventoryConstitute

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/result/epd/inventory/constitute HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
code	string	Yes	The enterprise code.	C-20080808-1
productId	integer	Yes	The product ID.	1024
productType	integer	Yes	The product type. Set this to 1 for a product carbon footprint request. Set this to 5 for a supply chain carbon footprint request.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request. This value is unique for each request. Use this ID to troubleshoot issues.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	array	A list of environmental impact results.
	EpdInventoryConstituteItem	An environmental impact result item.

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": [
    {
      "inventoryValuePerProduct": 1,
      "factorDataset": "/",
      "percent": 31.4,
      "inventoryValuePerProductUnit": "kg",
      "num": 1,
      "quantity": 1,
      "resourceType": "Energy",
      "factorType": 1,
      "unit": "kg CO2-Eq",
      "name": "climate change",
      "inventoryId": 1,
      "inventoryValue": 2,
      "factorUnit": "kg CO2-Eq/kg",
      "inventoryUnit": "t",
      "state": 1,
      "factor": "1.0000",
      "carbonEmission": 1009.97626554,
      "factorId": "1234",
      "items": [
        {
          "inventoryValuePerProduct": 1,
          "factorDataset": "/",
          "percent": 31.4,
          "inventoryValuePerProductUnit": "kg",
          "num": 1,
          "quantity": 1,
          "resourceType": "Energy",
          "factorType": 1,
          "unit": "kg CO2-Eq",
          "name": "climate change",
          "inventoryId": 1,
          "inventoryValue": 2,
          "factorUnit": "kg CO2-Eq/kg",
          "inventoryUnit": "t",
          "state": 1,
          "factor": "1.0000",
          "carbonEmission": 1009.97626554,
          "factorId": "1234",
          "items": [
            {
              "inventoryValuePerProduct": 1,
              "factorDataset": "/",
              "percent": 31.4,
              "inventoryValuePerProductUnit": "kg",
              "num": 1,
              "quantity": 1,
              "resourceType": "Energy",
              "factorType": 1,
              "unit": "kg CO2-Eq",
              "name": "climate change",
              "inventoryId": 1,
              "inventoryValue": 2,
              "factorUnit": "kg CO2-Eq/kg",
              "inventoryUnit": "t",
              "state": 1,
              "factor": "1.0000",
              "carbonEmission": 1009.97626554,
              "factorId": "1234",
              "items": []
            }
          ]
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.