GetDataQualityAnalysis - 获取数据质量评价结果DQR、DQI

获取数据质量评价结果DQR、DQI。

接口说明

用户指产品 id,本接口返回获得已经生成结果页中的数据质量评价结果。可用于了解产品各清单的碳排因子的数据质量。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
energy:GetDataQualityAnalysisnone
*全部资源
*

请求语法

POST /api/v1/carbon/footprint/data/quality/analysis HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求参数。

codestring

企业编码。

C-20080808-1
dataQualityEvaluationTypelong

数据质量评估类型:1 是 DQI、2 是 DQR。

1
productIdlong

产品 id。

1024
productTypelong

产品类型:1 表示请求产品碳足迹,5 表示请求供应链碳足迹。

1

返回参数

名称类型描述示例值
object
requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题。

4A0AEC56-5C9A-5D47-93DF-7227836FFF82
dataobject

返回数据。

dataQualityarray<object>

各清单的得分。

dataQualityobject
inventorystring

清单名称。

工序-1/清单-1
scoreobject

得分。分布范围 1~5,越接近 1 表示数据质量越好。

g1double

数据质量评价指标 1:活动数据可信度

3
g2double

数据质量评价指标 2:因子数据可信度

3
g3double

数据质量评价指标 3:时间代表性

3
g4double

数据质量评价指标 4:地理代表性

3
dataQualityResultobject

指标得分

data_quality_scoredouble

评分。适用于 DQR 结果,分布范围 1~5,越接近 1 表示数据质量越好,有效位数保留小数点后 4 位。

1.2345
g1double

数据质量评价指标 1:活动数据可信度

1.2345
g2double

数据质量评价指标 2:因子数据可信度

1.2345
g3double

数据质量评价指标 3:时间代表性

1.2345
g4double

数据质量评价指标 4:地理代表性

1.2345
sensitivityListarray<object>

敏感度分析列表

sensitivityListobject
idstring

清单项 id

1
inventorystring

清单项的名称

清单1
reductionListarray

减排措施列表

reductionListstring

清单项的减排措施

措施1
sensitivitydouble

灵敏度百分比

91.7
uncertaintystring

不确定性值。模型整体不确定性百分比结果,"10.00"表示 10.00%的不确定性,代表碳足迹结果在±10.00%的范围。由单一清单的不确定性贡献加权叠加得到。

10.00
uncertaintyValuesarray<object>

不确定性列表

uncertaintyValuesobject
inventorystring

清单名称。格式为:工序名/清单名。

工序-1/清单-1
uncertaintyContributionstring

清单的不确定性绝对贡献大小。建模过程中的各清单数据质量对碳足迹结果的影响,当某个清单的不确定贡献大时,请尽可能提高它的数据质量以提升碳足迹分析准确度。 "1.4964"的含义是不确定贡献了 1.4964 kgCO₂e/unit,其中 unit 为产品的单位。

1.4964

示例

正常返回示例

JSON格式

{
  "requestId": "4A0AEC56-5C9A-5D47-93DF-7227836FFF82",
  "data": {
    "dataQuality": [
      {
        "inventory": "工序-1/清单-1",
        "score": {
          "g1": 3,
          "g2": 3,
          "g3": 3,
          "g4": 3
        }
      }
    ],
    "dataQualityResult": {
      "data_quality_score": 1.2345,
      "g1": 1.2345,
      "g2": 1.2345,
      "g3": 1.2345,
      "g4": 1.2345
    },
    "sensitivityList": [
      {
        "id": 1,
        "inventory": "清单1",
        "reductionList": [
          "措施1"
        ],
        "sensitivity": 91.7
      }
    ],
    "uncertainty": 10,
    "uncertaintyValues": [
      {
        "inventory": "工序-1/清单-1",
        "uncertaintyContribution": 1.4964
      }
    ]
  }
}

错误码

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