Lineage import

Function

Lineage query.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/lineage/import

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
workspace	Yes	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	Yes	Array of TableLineage objects	Lineage information list.

**Table 4** TableLineage
Parameter	Mandatory	Type	Description
name	Yes	String	Name of a job operator.
input_tables	Yes	Array of TableInfo objects	Upstream lineage table list. The list size ranges from 1 to 100.
output_tables	Yes	Array of TableInfo objects	Downstream lineage table list. The list size ranges from 1 to 100.
source_connection_id	Yes	String	Source data connection ID.
target_connection_id	No	String	ID of the target data connection.
column_lineages	No	Array of ColumnLineage objects	Field lineage list. The list size ranges from 0 to 100.

**Table 5** TableInfo
Parameter	Mandatory	Type	Description
database	No	String	Database name
schema	No	String	Schema name
table	No	String	Table name

**Table 6** ColumnLineage
Parameter	Mandatory	Type	Description
name	Yes	String	Name of a job operator.
input_columns	Yes	Array of ColumnDetails objects	List of upstream lineage fields. The list size ranges from 1 to 100.
output_columns	Yes	Array of ColumnDetails objects	List of downstream lineage fields. The list size ranges from 1 to 100.

**Table 7** ColumnDetails
Parameter	Mandatory	Type	Description
database	No	String	Database name
schema	No	String	Schema name
table	No	String	Table name
column	No	String	Specifies the column name.

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
[items]	Array of ObjectIdInfo objects	Lineage Import Result

**Table 9** ObjectIdInfo
Parameter	Type	Description
name	String	Name of a job operator.
type_name	String	Asset type.
qualified_name	String	Uniquely qualified name of a job asset.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

[ {
  "name" : "test1221",
  "input_tables" : [ {
    "database" : "wk",
    "schema" : null,
    "table" : "wk_shuju1"
  } ],
  "output_tables" : [ {
    "database" : "wk",
    "schema" : null,
    "table" : "wk_shuju2"
  } ],
  "source_connection_id" : "aa0e89b9c7c14a6b9737d56a53d7a286",
  "target_connection_id" : "aa0e89b9c7c14a6b9737d56a53d7a286",
  "column_lineages" : [ ]
} ]

Example Responses

Status code: 200

OK.

[ {
  "name" : "test",
  "type_name" : "Node",
  "qualified_name" : "manual.a0683065-cfb6-42d3-a0ff-87b2cc5e3c79@node.0833a5737480d53b2f25c010dc1a7b88-workspace-ee119e8faee347a389e8c295b926331c"
} ]