文档

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

更新时间:

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

调试

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

授权信息

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

请求参数

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

数据作品的 ID。

abcd****

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

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

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

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject []

作品血缘信息列表。

ComponentIdstring

组件 ID。

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

组件名称。

线图
ComponentTypeinteger

组件类型。

3
ComponentTypeNamestring

组件类型名称。

LINE
QueryParamsobject []

查询参数引用列的列表。

Uidstring

字段唯一 ID。

Ndc78a4_order_number
PathIdstring

全局唯一的 PathId。

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

字段原名。

order_number
DataTypestring

字段类型。取值范围:

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

是否是度量。取值范围:

true:是 false:否

true
AreaIdstring

所属位置 ID。

area_column
AreaNamestring

所属位置名称。

列(度量)
DatasetIdstring

数据集 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 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.该空间不在组织内。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

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