Obtain the blood relationship of a data work with QueryWorksBloodRelationship - Quick BI - Alibaba Cloud - Quick BI

Queries the data lineage of a data work, including datasets referenced by each component and query field information. Supported data works: dashboards, workbooks, and self-service data retrieval.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryWorksBloodRelationship

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorksId	string	Yes	The ID of the data work.	abcd****

Response elements

Element	Type	Description	Example
	object	The response.
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	array<object>	The data lineage information of the work.
	array<object>
ComponentId	string	The ID of the component.	0696083a-ca72-4d89-8e7a-c017910e0***
ComponentName	string	The name of the component.	线图
ComponentType	integer	The type of the component.	3
ComponentTypeName	string	The name of the component type.	LINE
ComponentTypeCnName	string	The Chinese name of the component type.	交叉表
DatasetId	string	The ID of the dataset.	dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record
QueryParams	array<object>	The query fields referenced by the component.
	object
AreaId	string	The ID of the area where the field is located.	area_column
AreaName	string	The name of the area where the field is located.	列（度量）
Caption	string	The display name of the field.	order_number
DataType	string	The type of the field. Valid values: string: string type date: a date type that contains only the year, month, and day parts datetime: a common date type time: a date type that contains only hours, minutes, and seconds. number: numeric boolean: Boolean type geographical: geographical location url: string type imageUrl: the type of the image link. multivalue: a multi-value column	number
IsMeasure	boolean	Indicates whether the field is a measure. Valid values: true false	true
PathId	string	The globally unique PathId.	schema7d1944eb-443e-48c6-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]
Uid	string	The unique ID of the field.	Ndc78a4_order_number
Expression	string	The calculated field expression.	BI_DATEADD([时间], 100, 'day')

Examples

Success response

JSON format

{
  "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')"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Invalid.Works.Empty	This work does not exist. It may have been deleted. Work ID is %s.
400	Invalid.WorksId.Not.Publish	Works %s is not published yet.
400	Invalid.Workspace	The workspace is not owned by the organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.