Use GetOrgConstitute to retrieve organizational carbon inventory data - Energy Expert

Operation description

The code parameter is the unique code for an organization.
Retrieves data for the organization specified by the code.
It also recursively retrieves data for all child organizations.
The data for child organizations is returned in the subEmissionItems field.
The recursion continues until an organization has no child organizations.

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:GetOrgConstitute

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/emission/analysis/org HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The parameters in the request body.
code	string	Yes	The organization code.	Z-20240115-2
year	integer	Yes	The year.	2024
moduleCode	string	No	The module code.	carbonInventory.check.scope_1_direct_ghg_emissions
moduleType	integer	Yes	The module type.	3

Response elements

Element	Type	Description	Example
	object	The response struct.
requestId	string	The request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	OrgEmission	The response data.

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "name": "EnterpriseZ",
    "nameKey": "Z-20240115-4",
    "carbonEmissionData": 1.2,
    "weightingCarbonEmissionData": 2.3,
    "weightingRatio": 0.4,
    "ratio": 0.2,
    "weightingProportion": 0.3,
    "moduleEmissionList": [
      {
        "name": "Scope 1: Direct GHG emissions",
        "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
        "carbonEmissionData": 1.2,
        "ratio": 0.2
      }
    ],
    "subEmissionItems": [
      {
        "name": "EnterpriseZ",
        "nameKey": "Z-20240115-4",
        "carbonEmissionData": 1.2,
        "weightingCarbonEmissionData": 2.3,
        "weightingRatio": 0.4,
        "ratio": 0.2,
        "weightingProportion": 0.3,
        "moduleEmissionList": [
          {
            "name": "Scope 1: Direct GHG emissions",
            "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
            "carbonEmissionData": 1.2,
            "ratio": 0.2
          }
        ],
        "subEmissionItems": [
          {
            "name": "EnterpriseZ",
            "nameKey": "Z-20240115-4",
            "carbonEmissionData": 1.2,
            "weightingCarbonEmissionData": 2.3,
            "weightingRatio": 0.4,
            "ratio": 0.2,
            "weightingProportion": 0.3,
            "moduleEmissionList": [
              {
                "name": "Scope 1: Direct GHG emissions",
                "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
                "carbonEmissionData": 1.2,
                "ratio": 0.2
              }
            ],
            "subEmissionItems": []
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.