GetOrgConstitute - 碳盘查组织分析

本接口用于获取碳盘查组织分析数据。

接口说明

  1. 本接口请求参数中的 code 为企业编码。

  2. 本接口获取的是请求参数 code 对应的企业的数据及其递归子级数据。

  3. 关于上述子级数据,其含义是,企业的子级企业的数据。

  4. 关于上述子级企业的数据,其包含在企业数据的 subEmissionItems 字段中。

  5. 关于上述的递归,其含义是,一直获取企业的子级数据,直到其没有子级企业为止。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

energy:GetOrgConstitute

none

*全部资源

*

请求语法

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

请求参数

名称

类型

必填

描述

示例值

body

object

请求体参数。

code

string

企业 code。

Z-20240115-2

year

integer

年份。

2024

moduleCode

string

模块编码。

carbonInventory.check.scope_1_direct_ghg_emissions

moduleType

integer

模块类型。

3

返回参数

名称

类型

描述

示例值

object

返回结构体。

requestId

string

请求 ID。

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

data OrgEmission

返回数据。

示例

正常返回示例

JSON格式

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "name": "企业1",
    "nameKey": "Z-20240115-4",
    "carbonEmissionData": 1.2,
    "weightingCarbonEmissionData": 2.3,
    "weightingRatio": 0.4,
    "ratio": 0.2,
    "weightingProportion": 0.3,
    "moduleEmissionList": [
      {
        "name": "范围一:直接排放(企业生产经营过程产生的直接温室气体排放量)",
        "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
        "carbonEmissionData": 1.2,
        "ratio": 0.2
      }
    ],
    "subEmissionItems": [
      {
        "name": "企业1",
        "nameKey": "Z-20240115-4",
        "carbonEmissionData": 1.2,
        "weightingCarbonEmissionData": 2.3,
        "weightingRatio": 0.4,
        "ratio": 0.2,
        "weightingProportion": 0.3,
        "moduleEmissionList": [
          {
            "name": "范围一:直接排放(企业生产经营过程产生的直接温室气体排放量)",
            "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
            "carbonEmissionData": 1.2,
            "ratio": 0.2
          }
        ],
        "subEmissionItems": [
          {
            "name": "企业1",
            "nameKey": "Z-20240115-4",
            "carbonEmissionData": 1.2,
            "weightingCarbonEmissionData": 2.3,
            "weightingRatio": 0.4,
            "ratio": 0.2,
            "weightingProportion": 0.3,
            "moduleEmissionList": [
              {
                "name": "范围一:直接排放(企业生产经营过程产生的直接温室气体排放量)",
                "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
                "carbonEmissionData": 1.2,
                "ratio": 0.2
              }
            ],
            "subEmissionItems": []
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情