Asset catalog APIs
Asset catalog APIs allow you to do the following:
- Custom metadata. Add, modify, and delete custom metadata.
- Lineage. Retrieve data lineage for one or all pipelines executed in an environment.
- Catalog. Retrieve details of individual tasks, pipelines, or accounts or each of these asset types.
| Custom Metadata APIs | |
|---|---|
POST
/catalog/{env_org}/custom-metadata
|
Create custom metadata values for an Asset catalog task record. |
GET
/catalog/{env_org}/custom-metadata |
Retrieve all custom metadata values for an Asset catalog task record. |
PATCH
/catalog/{env_org}/custom-metadata |
Update custom metadata values for an Asset catalog task record. |
DELETE
/catalog/{env_org}/custom-metadata |
Delete custom metadata values for an Asset catalog task record. |
POST
/catalog/{env_org}/custom-metadata/columns |
Create custom metadata columns in the Asset catalog for all tasks in the environment. The new columns contain no values. |
DELETE
/catalog/{env_org}/custom-metadata/columns |
Delete custom metadata columns from the Asset catalog for all tasks in the environment. |
| Lineage APIs | |
GET
/catalog/{env_org}/lineage
|
Retrieve data lineage for all pipelines executed in the environment. |
GET
/catalog/{env_org}/lineage/{pipeline_snode_id}
|
Retrieve data lineage for pipeline with specified id. |
| Catalog APIs | |
GET
/catalog/{env_org}/tasks
|
Retrieves details of all tasks in the catalog. |
GET
/catalog/{env_org}/pipelines
|
Retrieves details for all the pipelines in the catalog. |
GET
/catalog/{env_org}/accounts
|
Retrieves details for all the accounts in the catalog. |
GET
/catalog/{env_org}/tasks/{job_id} |
Retrieves details of task with the specified job id from the catalog. |
GET
/catalog/{env_org}/pipelines/{pipeline_id}
|
Retrieves details of pipeline with the specified pipeline id from the catalog. |
GET
/catalog/{eng_org}/accounts/{account_id}
|
Retrieves details of account with the specified account id from the catalog. |