QueryWorks接口用于查询指定报表的血缘信息。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryWorksBloodRelationship

要执行的操作。取值:QueryWorksBloodRelationship

WorksId String abcd****

报表ID。

返回数据

名称 类型 示例值 描述
Success Boolean true

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

  • true:请求成功
  • false:请求失败
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Array of Item

作品血缘信息列表。

ComponentId String 0696083a-ca72-4d89-8e7a-c017910e0***

组件ID。

ComponentName String 线图

组件名称。

ComponentType Integer 3

组件类型。

ComponentTypeName String LINE

组件类型名称。

QueryParams Array of QueryParam

查询参数引用的列的列表。

Uid String Ndc78a4_order_number

字段唯一ID。

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

全局唯一的PathId。

Caption String order_number

字段显示名称。

DataType String number

字段类型。取值范围:

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

是否是度量。取值范围:

  • true:是
  • false:否
AreaId String area_column

所属位置ID。

AreaName String 列(度量)

所属位置名称。

DatasetId String dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record

数据集ID。

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=QueryWorksBloodRelationship
&WorksId=abcd****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止,您的实例版本或者 AccessKey不允许调用该 API。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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