获取数据作品的血缘关系,包括各组件引用的数据集以及查询字段信息。目前仅支持的数据作品包含仪表板、电子表格、自助取数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
WorksId | string | 是 | 数据作品的 ID。 | abcd**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": [
{
"ComponentId": "0696083a-ca72-4d89-8e7a-c017910e0***",
"ComponentName": "线图",
"ComponentType": 3,
"ComponentTypeName": "LINE",
"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"
}
]
}
],
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Invalid.Works.Empty | This work does not exist. It may have been deleted. Work ID is %s. | 作品不存在,可能已经被删除。作品ID:%s。 |
400 | Invalid.WorksId.Not.Publish | Works %s is not published yet. | 作品%s还未发布。 |
400 | Invalid.Workspace | The workspace is not owned by the organization. | 该空间不在组织内。 |
400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
400 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
400 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
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 | Access.Forbidden | Your instance version or access key is not allowed to call the API operation, only professional version supports calling. | 您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。 |
400 | UserInfo.Error | The personal information is invalid. | 个人信息不合法。 |
400 | ApiUser.Not.Exists | The specified user does not exist. | 用户不存在。 |
400 | User.Not.WorkspaceAdmin | Only administrators of the group workspace can perform this operation. | 没有权限,您不是该群空间的管理员。 |
400 | Application.Object.NotExist | The object you are operating does not exist or has been deleted. | 操作组件不存在或已被删除。 |
400 | Not.ApiCall.AuthUser | You are not an administrator or API call auth user of this organization. | 非组织管理员或API调用授权用户。 |
访问错误中心查看更多错误码。