DataWorks:CreateLineageRelationship

1. DataWorks Professional Edition or a higher edition is required.

Entity object (SrcEntity / DstEntity)

Describes the source and destination of a lineage relationship. You can register lineage relationships between the following types of entities:

Additional notes:

• For tables, columns, datasets, and dataset versions already collected by DataWorks, do not manually construct the Id. Use the Id returned by the corresponding Get or List API.

• For custom objects, use the user-registered custom entity object approach. Complete the entity definition and entity object registration first:

  1. Call CreateMetaEntityDef to create a custom entity definition.

  2. Call BatchCreateMetaEntities to create specific entity objects.

  3. Use the entity Id returned by BatchCreateMetaEntities as SrcEntity.Id or DstEntity.Id.

• For non-managed custom objects, you do not need to call CreateMetaEntityDef or BatchCreateMetaEntities. Simply pass an entity Id prefixed with custom- and specify the Name. This approach is mainly for backward compatibility with legacy scenarios and is no longer recommended. For new integrations, use the registered custom entity object approach for easier querying, management, and custom attribute extension.

• SrcEntity.Attributes and DstEntity.Attributes represent extended attributes of the entity endpoints. Place attributes of the lineage relationship itself in Task.Attributes.

Task information (Task)

Describes the job or task that produces the lineage relationship.

Request examples.

DataWorks collected table and custom entity object

{
  "SrcEntity": {
    "Id": "custom_entity-customer_api:api_001",
    "Name": "api_001"
  },
  "DstEntity": {
    "Id": "mysql-table:rm-xxx::demo_db::demo_table",
    "Name": "demo_table"
  },
  "Task": {
    "Id": "api_to_table_001",
    "Type": "custom-lineage-task",
    "Attributes": {
      "scene": "api_to_table",
      "owner": "zhangsan"
    }
  }
}
```.

### Non-managed custom object and DataWorks collected table

> This approach is mainly for backward compatibility with legacy usage and is no longer recommended. For new integrations, register custom entity objects by using `CreateMetaEntityDef` and `BatchCreateMetaEntities` first, and then use the returned entity `Id` to register the lineage.

```json
{
  "SrcEntity": {
    "Id": "custom-report:report_001",
    "Name": "report_001"
  },
  "DstEntity": {
    "Id": "maxcompute-table:::demo_project:default:demo_table",
    "Name": "demo_table"
  },
  "Task": {
    "Id": "report_to_table_001",
    "Type": "custom-lineage-task",
    "Attributes": {
      "scene": "report_to_table"
    }
  }
}
```.