QueryWorksBloodRelationship - 查询数据作品的血缘信息

获取数据作品的血缘关系,包括各组件引用的数据集以及查询字段信息。目前仅支持的数据作品包含仪表板、电子表格、自助取数。

调试

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

授权信息

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

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

请求参数

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

数据作品的 ID。

abcd****

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultarray<object>

作品血缘信息列表。

Itemobject

作品血缘详情信息。

ComponentIdstring

组件 ID。

0696083a-ca72-4d89-8e7a-c017910e0***
ComponentNamestring

组件名称。

线图
ComponentTypeinteger

组件类型。

3
ComponentTypeNamestring

组件类型名称。

LINE
ComponentTypeCnNamestring

组件类型中文名称。

交叉表
DatasetIdstring

数据集 ID。

dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record
QueryParamsarray<object>

查询参数引用列的列表。

QueryParamobject

字段信息。

AreaIdstring

所属位置 ID。

area_column
AreaNamestring

所属位置名称。

列(度量)
Captionstring

字段原名。

order_number
DataTypestring

字段类型。取值范围:

  • string:字符串类型
  • date:仅包含年月日部分的日期类型
  • datetime:通用日期类型
  • time:仅包含时分秒部分的日期类型
  • number:数值类型
  • boolean:布尔类型
  • geographic:地理位置
  • url:字符串类型
  • imageUrl:图片链接类型
  • multivalue:多值列
number
IsMeasureboolean

是否是度量。取值范围:

true:是 false:否

true
PathIdstring

全局唯一的 PathId。

schema7d1944eb-443e-48c6-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]
Uidstring

字段唯一 ID。

Ndc78a4_order_number
Expressionstring

计算字段表达式。

BI_DATEADD([时间], 100, 'day')

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": [
    {
      "ComponentId": "0696083a-ca72-4d89-8e7a-c017910e0***",
      "ComponentName": "线图",
      "ComponentType": 3,
      "ComponentTypeName": "LINE",
      "ComponentTypeCnName": "交叉表",
      "DatasetId": "dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record",
      "QueryParams": [
        {
          "AreaId": "area_column",
          "AreaName": "列(度量)",
          "Caption": "order_number",
          "DataType": "number",
          "IsMeasure": true,
          "PathId": "schema7d1944eb-443e-48c6-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]",
          "Uid": "Ndc78a4_order_number",
          "Expression": "BI_DATEADD([时间], 100, 'day')"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Invalid.Works.EmptyThis work does not exist. It may have been deleted. Work ID is %s.作品不存在,可能已经被删除。作品ID:%s。
400Invalid.WorksId.Not.PublishWorks %s is not published yet.作品%s还未发布。
400Invalid.WorkspaceThe workspace is not owned by the organization.该空间不在组织内。

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