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

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
WorksId	string	是	数据作品的ID。	abcd****

返回参数

名称	类型	描述	示例值
	object	返回结果。
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true
RequestId	string	请求ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	array	作品血缘信息列表。
	object
ComponentId	string	组件ID。	0696083a-ca72-4d89-8e7a-c017910e0***
ComponentName	string	组件名称。	线图
ComponentType	integer	组件类型。	3
ComponentTypeName	string	组件类型名称。	LINE
QueryParams	array	查询参数引用列的列表。
	object
Uid	string	字段唯一ID。	Ndc78a4_order_number
PathId	string	全局唯一的PathId。	schema7d1944eb-443e-48c6-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]
Caption	string	字段显示名称。	order_number
DataType	string	字段类型。取值范围： string：字符串类型 date：仅包含年月日部分的日期类型 datetime：通用日期类型 time：仅包含时分秒部分的日期类型 number：数值类型 boolean：布尔类型 geographic：地理位置 url：字符串类型 imageUrl：图片链接类型 multivalue：多值列	number
IsMeasure	boolean	是否是度量。取值范围： true：是 false：否	true
AreaId	string	所属位置ID。	area_column
AreaName	string	所属位置名称。	列（度量）
DatasetId	string	数据集ID。	dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record

示例

正常返回示例

JSON格式

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

错误码

Http code	错误码	错误信息	描述
400	Invalid.Works.Empty	works not exist,the report has been deleted!reportId:%s	-
400	Invalid.WorksId.Not.Publish	works %s is not published yet	-
400	Invalid.Workspace	workspace not in organization	-
400	Instance.Expired	Your instance has expired.	您的购买实例已经过期。
400	Instance.Not.Exist	The specified instance does not exist.	暂未匹配到您的购买实例。
400	Access.Forbidden	Access forbidden. Your instance version or access key is not allowed to call the API operation.	-
400	Internal.System.Error	An internal system error occurred.	系统内部异常。
400	Invalid.Organization	The specified organizational unit does not exist.	该组织不存在。
400	User.Not.In.Organization	The specified user is not in the organizational unit.	该用户不在组织中。
400	Invalid.Parameter	An error occurred while verifying parameters.	参数验证失败。
400	Invalid.Parameter.Error	The parameter is invalid:%s.	无效参数%s。
400	Invalid.Param.Error	The parameter is invalid.	无效参数。
400	Invalid.User.Admin	You are not an administrator of this organization.	没有权限，您不是组织管理员。
400	System.Param.Empty	You must specify the %s parameter.	参数%s不能为空。
400	UserInfo.Error	The personal information is invalid.	个人信息不合法。
400	ApiUser.Not.Exists	The specified user does not exist.	用户不存在。

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