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

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Obtains the kinship of a data work, including the datasets referenced by each component and query field information. Currently, only supported data works include dashboards, workbooks, and self-service data retrieval.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:QueryWorksBloodRelationship	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	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>	List of work blood information.
Item	object
ComponentId	string	The ID of the component that you want to modify.	0696083a-ca72-4d89-8e7a-c017910e0***
ComponentName	string	The name of the component.	Line
ComponentType	integer	The type of the image component.	3
ComponentTypeName	string	The name of the component type.	LINE
ComponentTypeCnName	string	Chinese name of the component type	ddd
DatasetId	string	The ID of the training dataset that you want to remove from the specified custom linguistic model.	dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record
QueryParams	array<object>	A list of query parameter reference columns.
QueryParam	object
AreaId	string	The ID of the owning location.	area_column
AreaName	string	The name of the owning location.	Column (Measure)
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	Indices whether the metric. 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	Calculate field expression.	BI_DATEADD([date], 100, 'day')

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": [
    {
      "ComponentId": "0696083a-ca72-4d89-8e7a-c017910e0***",
      "ComponentName": "Line\n",
      "ComponentType": 3,
      "ComponentTypeName": "LINE",
      "ComponentTypeCnName": "ddd",
      "DatasetId": "dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record",
      "QueryParams": [
        {
          "AreaId": "area_column",
          "AreaName": "Column (Measure)\n",
          "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([date], 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.

For a list of error codes, visit the Service error codes.