IBM Manta Data Lineage | IBM Cloud API Docs

Introduction to IBM Manta Data Lineage as a Service

Last updated: 2024-12-11

You can use the IBM Manta Data Lineage as a Service REST APIs to see the journey data takes from its origin, through transformations to consumers.

If you are looking for IBM Manta Data Lineage software APIs, see here.

For more information, see these resources:

Documentation for Cloud Pak for Data as a Service

Endpoint URL

https://api.dataplatform.cloud.ibm.com

Authentication

Before you can call a data lineage API you must first create an IAM bearer token. Each token is valid only for one hour, and after a token expires you must create a new one if you want to continue using the API. The recommended method to retrieve a token programmatically is to create an API key for your IBM Cloud identity and then use the IAM token API to exchange that key for a token.

You can create a token in IBM Cloud or by using the IBM Cloud command line interface (CLI).

To create a token in the IBM Cloud:

Log in to IBM Cloud and select Manage > Access (IAM) > API keys.
Create an API key for your own personal identity, copy the key value, and save it in a secure place. After you leave the page, you will no longer be able to access this value.
With your API key, set up a REST API tool and run the following command to the right

You can read more about managing API keys at Understanding API keys documentation page.

Use the value of the access_token property for your API calls. Set the access_token value as the authorization header parameter for requests to the APIs. The format is Authorization: Bearer <access_token_value_here>. For example: Authorization: Bearer eyJhbGciOiJIUz......sgrKIi8hdFs

To create a token by using the IBM Cloud CLI:

Follow the steps to install the CLI, log in to IBM Cloud, and get the token described here. Remove Bearer from the returned IAM token value in your API calls.

Curl command with API key to retrieve token

curl -X POST 'https://iam.cloud.ibm.com/identity/token'   -H 'Content-Type: application/x-www-form-urlencoded'   -d 'grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=MY_APIKEY'

Response

{
"access_token": "eyJhbGciOiJIUz......sgrKIi8hdFs",
"refresh_token": "SPrXw5tBE3......KBQ+luWQVY=",
"token_type": "Bearer",
"expires_in": 3600,
"expiration": 1473188353
}
Copy to clipboard

Error handling

Responses with 400-series or 500-series status codes are returned when a request cannot be completed. The body of these responses follows the error model, which contains a code field to identify the problem and a message field to explain how to solve the problem. Each individual endpoint has specific error messages. All responses with 500 or 503 status codes are logged and treated as a critical failure requiring an emergency fix.

Get lineage asset details based on the ID of the requested asset.

GET /gov_lineage/v2/lineage_assets/{id}

Request

Path Parameters

id
Required*
string
Id of the requested asset

Response

Response Body

LineageLineageAsset

Lineage asset - graph representation of some structure that holds data

Status Code

200
Get successful
404
Entity not found

Example responses

Status 200

{
  "attributes": [
    {
      "name": "COLUMN_CONSTRAINT",
      "value": "primary key"
    }
  ],
  "business_classifications": [
    {
      "id": "e441721f-7369-4547-9aac-a278dfb74f05",
      "name": "Home Loan"
    }
  ],
  "business_terms": [
    {
      "id": "8d3641e9-841f-40d0-aa0b-f5e8e8b97186",
      "name": "Personal Information"
    }
  ],
  "catalog_assignments": [
    {
      "catalog": {
        "id": "33194072-e58e-476c-b094-412fd6e658d8",
        "name": "Very Enterprise Catalog"
      },
      "data_quality": {
        "score": 83.5
      },
      "cams_asset_id": "7a5d09ce-05a6-4f64-8a29-e9dee5f3a5b3"
    }
  ],
  "children": {
    "count": 0,
    "has_any": false,
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children"
  },
  "hierarchical_path": [
    {
      "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
      "name": "postgres",
      "type": "Database"
    },
    {
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "name": "s1",
      "type": "Schema"
    },
    {
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "name": "table1",
      "type": "Table"
    }
  ],
  "data_classes": [
    {
      "id": "3652f859-397e-4fa3-80ac-86e11a5379c4",
      "name": "First Name"
    }
  ],
  "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
  "is_deduced": false,
  "is_favorite": false,
  "name": "first_name",
  "project_assignments": [
    {
      "project": {
        "id": "ed99846a-2194-4826-9be5-0a805c811238",
        "name": "My Little Project"
      },
      "data_quality": {
        "score": 83.5
      },
      "cams_asset_id": "c4ce19e0-8ad4-42a6-9472-6290c92c8f0c"
    }
  ],
  "resource_key": "PostgreSQL/postgres/s1/table1/first_name",
  "tags": [
    "PII"
  ],
  "technology": {
    "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
    "name": "PostgreSQL"
  },
  "type": "Column"
}
Copy to clipboard

Update lineage asset

PATCH /gov_lineage/v2/lineage_assets/{id}

Request

Path Parameters

id
Required*
string
Id of the asset which will be updated

Request Body

application/merge-patch+jsonLineageLineageAssetPatch

Request for patching lineage asset in the format of application/merge-patch+json

Examples:

Response

Response Body

LineageLineageAsset

Lineage asset - graph representation of some structure that holds data

Status Code

200
Get successful
404
Entity not found

Example responses

Status 200

{
  "attributes": [
    {
      "name": "COLUMN_CONSTRAINT",
      "value": "primary key"
    }
  ],
  "business_classifications": [
    {
      "id": "e441721f-7369-4547-9aac-a278dfb74f05",
      "name": "Home Loan"
    }
  ],
  "business_terms": [
    {
      "id": "8d3641e9-841f-40d0-aa0b-f5e8e8b97186",
      "name": "Personal Information"
    }
  ],
  "catalog_assignments": [
    {
      "catalog": {
        "id": "33194072-e58e-476c-b094-412fd6e658d8",
        "name": "Very Enterprise Catalog"
      },
      "data_quality": {
        "score": 83.5
      },
      "cams_asset_id": "7a5d09ce-05a6-4f64-8a29-e9dee5f3a5b3"
    }
  ],
  "children": {
    "count": 0,
    "has_any": false,
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children"
  },
  "hierarchical_path": [
    {
      "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
      "name": "postgres",
      "type": "Database"
    },
    {
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "name": "s1",
      "type": "Schema"
    },
    {
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "name": "table1",
      "type": "Table"
    }
  ],
  "data_classes": [
    {
      "id": "3652f859-397e-4fa3-80ac-86e11a5379c4",
      "name": "First Name"
    }
  ],
  "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
  "is_deduced": false,
  "is_favorite": false,
  "name": "first_name",
  "project_assignments": [
    {
      "project": {
        "id": "ed99846a-2194-4826-9be5-0a805c811238",
        "name": "My Little Project"
      },
      "data_quality": {
        "score": 83.5
      },
      "cams_asset_id": "c4ce19e0-8ad4-42a6-9472-6290c92c8f0c"
    }
  ],
  "resource_key": "PostgreSQL/postgres/s1/table1/first_name",
  "tags": [
    "PII"
  ],
  "technology": {
    "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
    "name": "PostgreSQL"
  },
  "type": "Column"
}
Copy to clipboard

List lineage asset children based on the ID of the parent asset.

GET /gov_lineage/v2/lineage_assets/{id}/children

Request

Path Parameters

id
Required*
string
Id of the parent lineage asset

Query Parameters

name_prefix
string
Optional prefix of the name that filters the results. Only the assets with the name starting with prefix (case-insensitive) will be returned. If empty or not specified, all children are returned.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression ^.*$
lineage_initial_asset_ids
string
If specified, the response should only contain assets that are part of lineage defined by the specified asset ids. It means that only assets that are accessible (directly or transitively) from the specified asset ids will be returned. The ids are divided by commas, their order isn't taken into account.

Maximum: 100 items

Possible values: 1 ≤ length ≤ 6499, Value must match regular expression ^[\da-f]+(,[\da-f]+)*$
order
string
Definition of order of the returned values (minus as a prefix means descending order). Use "name" or "-name".

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^-?[a-z_]+$
Default: name
Example: -name
allow_lineage_cache
boolean
If true, the lineage graph can be loaded from a cache. If false, the lineage graph must be recalculated from the current data. This parameter only makes sense when lineage_initial_asset_ids is specified.

Default: true
offset
int32
The number of the first item in the page, starting from 0

Default: 0
limit
int32
Number of items being returned, must be 1 or higher

Possible values: value ≤ 1000
Default: 10

Response

Response Body

LineageListChildrenResponse

A slice of the result for getting child assets with information about its position in the ordered result and access to other pages.

Status Code

200
Get successful
404
Entity not found

Example responses

Status 200

{
  "children": [
    {
      "attributes": [
        {
          "name": "COLUMN_CONSTRAINT",
          "value": "primary key"
        }
      ],
      "business_classifications": [
        {
          "id": "e441721f-7369-4547-9aac-a278dfb74f05",
          "name": "Home Loan"
        }
      ],
      "business_terms": [
        {
          "id": "8d3641e9-841f-40d0-aa0b-f5e8e8b97186",
          "name": "Personal Information"
        }
      ],
      "catalog_assignments": [
        {
          "catalog": {
            "id": "33194072-e58e-476c-b094-412fd6e658d8",
            "name": "Very Enterprise Catalog"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "7a5d09ce-05a6-4f64-8a29-e9dee5f3a5b3"
        }
      ],
      "children": {
        "count": 0,
        "has_any": false,
        "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children"
      },
      "hierarchical_path": [
        {
          "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
          "name": "postgres",
          "type": "Database"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "s1",
          "type": "Schema"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "table1",
          "type": "Table"
        }
      ],
      "data_classes": [
        {
          "id": "3652f859-397e-4fa3-80ac-86e11a5379c4",
          "name": "First Name"
        }
      ],
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "is_deduced": false,
      "is_favorite": false,
      "name": "first_name",
      "project_assignments": [
        {
          "project": {
            "id": "ed99846a-2194-4826-9be5-0a805c811238",
            "name": "My Little Project"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "c4ce19e0-8ad4-42a6-9472-6290c92c8f0c"
        }
      ],
      "resource_key": "PostgreSQL/postgres/s1/table1/first_name",
      "tags": [
        "PII"
      ],
      "technology": {
        "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
        "name": "PostgreSQL"
      },
      "type": "Column"
    }
  ],
  "offset": 10,
  "limit": 5,
  "first": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children?offset=0&limit=5"
  },
  "last": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children?offset=25&limit=5"
  },
  "next": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children?offset=15&limit=5"
  },
  "previous": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children?offset=5&limit=5"
  },
  "total_count": 28
}
Copy to clipboard

List lineage assets

GET /gov_lineage/v2/lineage_assets

Request

Query Parameters

order
string
Definition of order of the returned values (minus as a prefix means descending order). Use "name" or "-name".

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^-?[a-z_]+$
Default: name
Example: -name
offset
int32
The number of the first item in the page, starting from 0

Default: 0
limit
int32
Number of items being returned, must be 1 or higher

Possible values: value ≤ 1000
Default: 10
top_level
boolean
Should the response only contain assets that have no parent?

Default: false
favorites
boolean
Should the response only contain favorite assets?

Default: false
ids
string
Ids of the requested assets delimited by comma. Maximum: 100 items

Possible values: 1 ≤ length ≤ 6499, Value must match regular expression ^[\da-f]+(,[\da-f]+)*$
parent_ids
string
Ids of the parents of the requested assets delimited by comma. If not specified, all assets are returned without a regard to their parents.

Maximum: 100 items

Possible values: 1 ≤ length ≤ 6499, Value must match regular expression ^[\da-f]+(,[\da-f]+)*$
return_total_count
boolean
Should the total number of assets be part of the response?

Default: false
lineage_initial_asset_ids
string
If specified, the response should only contain assets that are part of lineage defined by the specified asset ids. It means that only assets that are accessible (directly or transitively) from the specified asset ids will be returned. The ids are divided by commas, their order isn't taken into account.

Maximum: 100 items

Possible values: 1 ≤ length ≤ 6499, Value must match regular expression ^[\da-f]+(,[\da-f]+)*$
allow_lineage_cache
boolean
If true, the lineage graph can be loaded from a cache. If false, the lineage graph must be recalculated from the current data. This parameter only makes sense when lineage_initial_asset_ids is specified.

Default: true

Response

Response Body

LineageLineageAssetCollection

A slice of the result for getting lineage assets with information about its position in the ordered result and access to other pages.

Status Code

200
Get successful
401
Unauthorized
403
Forbidden. The user must have a proper role assigned to access this resource

Example responses

Status 200

{
  "lineage_assets": [
    {
      "attributes": [
        {
          "name": "COLUMN_CONSTRAINT",
          "value": "primary key"
        }
      ],
      "business_classifications": [
        {
          "id": "e441721f-7369-4547-9aac-a278dfb74f05",
          "name": "Home Loan"
        }
      ],
      "business_terms": [
        {
          "id": "8d3641e9-841f-40d0-aa0b-f5e8e8b97186",
          "name": "Personal Information"
        }
      ],
      "catalog_assignments": [
        {
          "catalog": {
            "id": "33194072-e58e-476c-b094-412fd6e658d8",
            "name": "Very Enterprise Catalog"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "7a5d09ce-05a6-4f64-8a29-e9dee5f3a5b3"
        }
      ],
      "children": {
        "count": 0,
        "has_any": false,
        "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children"
      },
      "hierarchical_path": [
        {
          "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
          "name": "postgres",
          "type": "Database"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "s1",
          "type": "Schema"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "table1",
          "type": "Table"
        }
      ],
      "data_classes": [
        {
          "id": "3652f859-397e-4fa3-80ac-86e11a5379c4",
          "name": "First Name"
        }
      ],
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "is_deduced": false,
      "is_favorite": false,
      "name": "first_name",
      "project_assignments": [
        {
          "project": {
            "id": "ed99846a-2194-4826-9be5-0a805c811238",
            "name": "My Little Project"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "c4ce19e0-8ad4-42a6-9472-6290c92c8f0c"
        }
      ],
      "resource_key": "PostgreSQL/postgres/s1/table1/first_name",
      "tags": [
        "PII"
      ],
      "technology": {
        "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
        "name": "PostgreSQL"
      },
      "type": "Column"
    }
  ],
  "offset": 10,
  "limit": 5,
  "first": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets?offset=0&limit=5"
  },
  "last": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets?offset=25&limit=5"
  },
  "next": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets?offset=15&limit=5"
  },
  "previous": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets?offset=5&limit=5"
  },
  "total_count": 28
}
Copy to clipboard

Lists distinct types of existing lineage assets

GET /gov_lineage/v2/lineage_asset_types

Request

Query Parameters

prefix
string
Optional prefix of the asset type that filters the results. Only the asset types starting with the prefix (case-insensitive) will be returned. If empty or not specified, all types are returned.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression ^.*$
order
string
Definition of order of the returned values (minus as a prefix means descending order). Use "asset_type" or "-asset_type".

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^-?[a-z_]+$
Default: asset_type
Example: -asset_type
offset
int32
The number of the first item in the page, starting from 0

Default: 0
limit
int32
Number of items being returned, must be 1 or higher

Possible values: value ≤ 1000
Default: 10

Response

Response Body

LineageAssetTypesResponse

A slice of the result for getting lineage assets types with information about its position in the ordered result and access to other pages.

Status Code

200
Get successful

Example responses

Status 200

{
  "lineage_asset_types": [
    "Column",
    "Table",
    "Database"
  ],
  "offset": 10,
  "limit": 5,
  "first": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_asset_types?offset=0&limit=5"
  },
  "last": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_asset_types?offset=25&limit=5"
  },
  "next": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_asset_types?offset=15&limit=5"
  },
  "previous": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_asset_types?offset=5&limit=5"
  },
  "total_count": 28
}
Copy to clipboard

Search distinct lineage asset names

POST /gov_lineage/v2/search_lineage_asset_names

Request

Request Body

Required*

LineageSearchAssetNamesRequest

Request for search of unique asset names

Response

Response Body

LineageSearchAssetNamesResponse

Response of search of lineage asset names

Status Code

200
Get successful

Example responses

Status 200

{
  "lineage_asset_names": [
    "car",
    "caraway",
    "carpet",
    "placard"
  ]
}
Copy to clipboard

Search and filter lineage assets

POST /gov_lineage/v2/search_lineage_assets

Request

Request Body

Required*

LineageSearchAssetRequest

Request for asset search

Response

Response Body

LineageSearchAssetResponse

Response of search for lineage assets. It contains a page with the search results.

Status Code

200
Get successful

Example responses

Status 200

{
  "lineage_assets": [
    {
      "attributes": [
        {
          "name": "COLUMN_CONSTRAINT",
          "value": "primary key"
        }
      ],
      "business_classifications": [
        {
          "id": "e441721f-7369-4547-9aac-a278dfb74f05",
          "name": "Home Loan"
        }
      ],
      "business_terms": [
        {
          "id": "8d3641e9-841f-40d0-aa0b-f5e8e8b97186",
          "name": "Personal Information"
        }
      ],
      "catalog_assignments": [
        {
          "catalog": {
            "id": "33194072-e58e-476c-b094-412fd6e658d8",
            "name": "Very Enterprise Catalog"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "7a5d09ce-05a6-4f64-8a29-e9dee5f3a5b3"
        }
      ],
      "children": {
        "count": 0,
        "has_any": false,
        "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children"
      },
      "hierarchical_path": [
        {
          "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
          "name": "postgres",
          "type": "Database"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "s1",
          "type": "Schema"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "table1",
          "type": "Table"
        }
      ],
      "data_classes": [
        {
          "id": "3652f859-397e-4fa3-80ac-86e11a5379c4",
          "name": "First Name"
        }
      ],
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "is_deduced": false,
      "is_favorite": false,
      "name": "first_name",
      "project_assignments": [
        {
          "project": {
            "id": "ed99846a-2194-4826-9be5-0a805c811238",
            "name": "My Little Project"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "c4ce19e0-8ad4-42a6-9472-6290c92c8f0c"
        }
      ],
      "resource_key": "PostgreSQL/postgres/s1/table1/first_name",
      "tags": [
        "PII"
      ],
      "technology": {
        "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
        "name": "PostgreSQL"
      },
      "type": "Column"
    }
  ],
  "offset": 10,
  "limit": 5,
  "total_count": 15
}
Copy to clipboard

Queries the data flow and returns a subset of the lineage graph.

The data flow lineage works with 3 main concepts: the full lineage graph, the limited graph ("initial lineage"), and view on the initial lineage. The initial lineage is a subset of graph that contains all assets accessible from the given starting nodes. This graph subset is too big to return and too big to navigate in. For this reason, the query response contains only a "view" which is a subset of the initial lineage. The view can always only contain one asset from the hierarchy (if column is present in the view, the table or schema it belongs to can't be part of the view. The already known view should be specified in the request, so that summary edges can be calculated correctly and the direct edges will point to the right assets when it's possible to choose several in the hierarchy.

The request contains the definition of a known view (e.g. the previous view the client already has) and a optional modifier which enhances the view. The response contains a view that is created by applying the modifier to the specified view. If no modifier is passed, the requested view is responded.

POST /gov_lineage/v2/query_lineage

Request

Request Body

Required*

LineageQueryLineageRequest

Generic request to query the data flow lineage. The client can choose from several modifiers which define how the responded view will differ compared to the input view. Only one (or no) modifier can be specified in a request.

Response

Response Body

LineageLineageGraph

Full representation of the lineage view (a subset of the assets in the lineage and the edgesbetween them).

Status Code

200
Get successful

Example responses

Status 200

{
  "assets_in_view": [
    {
      "attributes": [
        {
          "name": "COLUMN_CONSTRAINT",
          "value": "primary key"
        }
      ],
      "business_classifications": [
        {
          "id": "e441721f-7369-4547-9aac-a278dfb74f05",
          "name": "Home Loan"
        }
      ],
      "business_terms": [
        {
          "id": "8d3641e9-841f-40d0-aa0b-f5e8e8b97186",
          "name": "Personal Information"
        }
      ],
      "catalog_assignments": [
        {
          "catalog": {
            "id": "33194072-e58e-476c-b094-412fd6e658d8",
            "name": "Very Enterprise Catalog"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "7a5d09ce-05a6-4f64-8a29-e9dee5f3a5b3"
        }
      ],
      "children": {
        "count": 0,
        "has_any": false,
        "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children"
      },
      "hierarchical_path": [
        {
          "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
          "name": "postgres",
          "type": "Database"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "s1",
          "type": "Schema"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "table1",
          "type": "Table"
        }
      ],
      "data_classes": [
        {
          "id": "3652f859-397e-4fa3-80ac-86e11a5379c4",
          "name": "First Name"
        }
      ],
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "is_deduced": false,
      "is_favorite": false,
      "name": "first_name",
      "project_assignments": [
        {
          "project": {
            "id": "ed99846a-2194-4826-9be5-0a805c811238",
            "name": "My Little Project"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "c4ce19e0-8ad4-42a6-9472-6290c92c8f0c"
        }
      ],
      "resource_key": "PostgreSQL/postgres/s1/table1/first_name",
      "tags": [
        "PII"
      ],
      "technology": {
        "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
        "name": "PostgreSQL"
      },
      "type": "Column"
    },
    {
      "attributes": [],
      "business_classifications": [],
      "business_terms": [],
      "catalog_assignments": [],
      "children": {
        "count": 0,
        "has_any": false,
        "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/7e2f10223b4c01303e05c16055f9a865917108ce41084d08d86b4b7356693aad/children"
      },
      "hierarchical_path": [
        {
          "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
          "name": "postgres",
          "type": "Database"
        },
        {
          "id": "7e2f10223b4c01303e05c16055f9a865917108ce41084d08d86b4b7356693aad",
          "name": "s1",
          "type": "Schema"
        },
        {
          "id": "7e2f10223b4c01303e05c16055f9a865917108ce41084d08d86b4b7356693aad",
          "name": "table1",
          "type": "Table"
        }
      ],
      "data_classes": [],
      "id": "7e2f10223b4c01303e05c16055f9a865917108ce41084d08d86b4b7356693aad",
      "is_deduced": false,
      "is_favorite": false,
      "name": "eye_color",
      "project_assignments": [],
      "resource_key": "PostgreSQL/postgres/s1/table1/eye_color",
      "tags": [],
      "technology": {
        "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
        "name": "PostgreSQL"
      },
      "type": "Column"
    }
  ],
  "edges_in_view": [
    {
      "source": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "target": "7e2f10223b4c01303e05c16055f9a865917108ce41084d08d86b4b7356693aad",
      "type": "direct"
    },
    {
      "source": "7e2f10223b4c01303e05c16055f9a865917108ce41084d08d86b4b7356693aad",
      "target": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "type": "summary"
    }
  ],
  "graph_calculation_timestamp": 1766620800000
}
Copy to clipboard

Requests assets that are accessible upstream or downstream from the given set of starting assets. The returned assets might be accessible directly using one edge or transitively through several assets. The endpoint only returns assets that are part of the specified view (see below).

The data flow lineage works with 3 main concepts: the full lineage graph, the limited graph ("initial lineage"), and view on the initial lineage. The initial lineage is a subset of graph that contains all assets accessible from the given starting nodes. This graph subset is too big to return and too big to navigate in. For this reason, the query response contains only a "view" which is a subset of the initial lineage. The view can always only contain one asset from the hierarchy (if column is present in the view, the table or schema it belongs to can't be part of the view. This endpoint only returns assets that are part of the specified view.

The response always includes the starting assets themselves.

If more starting assets are specified, the response contains all assets that are accessible by at least one starting asset.

POST /gov_lineage/v2/query_relative_assets

Request

Request Body

Required*

LineageRelativeAssetsRequest

Request for the assets that are accessible upstream or downstream from the given set of starting assets.

Response

Response Body

LineageRelativeAssets

Response containing assets that have incoming or outgoing lineage from/to the starting nodes.

Status Code

200
Get successful

Example responses

Status 200

{
  "relative_assets": [
    "32792505335a8b2722e6d7b15c5f709665cc8dfc03b841657221f134af54af0a",
    "8075282f82e810f9a4af3100471310be6a628fe17800415c2541793444e7ed4a",
    "a3e2fef4eff20c363094a9c8aed5d4fcb8bccf1e73a72ce9afa14f9151d0f92c"
  ]
}
Copy to clipboard

Gets assets that are "hidden" by a summary edge. A summary edge between assets SOURCE and TARGET means that there is a lineage flow going from SOURCE to TARGET but it's not going directly between them but via several other assets in between. The assets between SOURCE and TARGET can be called "hidden". There might be several assets or even several different paths between the source and target, the summary edge contains all of them.

This endpoint allows to filter the hidden assets. If more edges are specified, the endpoint returns assets that are hidden by at least one summary edge. The response doesn't contain sources and targets.

The data flow lineage works with 3 main concepts: the full lineage graph, the limited graph ("initial lineage"), and view on the initial lineage. The initial lineage is a subset of graph that contains all assets accessible from the given starting nodes. This graph subset is too big to return and too big to navigate in. For this reason, the query response contains only a "view" which is a subset of the initial lineage. The view can always only contain one asset from the hierarchy (if column is present in the view, the table or schema it belongs to can't be part of the view. This endpoint only returns assets that are part of the specified view.

Even the endpoint for getting summary edge needs to know which assets are currently known by the client (= are part of the view) to decide the hierarchy level of returned assets. There's an assumption that no asset "hidden" by any summary edge is part of the view and that all sources and targets of the edges are part of the view.

POST /gov_lineage/v2/query_summary_edge_assets

Request

Request Body

Required*

LineageQuerySummaryEdgeAssetsRequest

Query to return assets that are hidden by the summary edges

Response

Response Body

LineageSummaryEdgeAssetsResponse

A slice of the result for getting lineage assets with information about its position in the ordered result and access to other pages.

Status Code

200
Get successful
400
The request includes parameters or values that are incorrect or unexpected

Example responses

Status 200

{
  "summary_edge_assets": [
    {
      "attributes": [
        {
          "name": "COLUMN_CONSTRAINT",
          "value": "primary key"
        }
      ],
      "business_classifications": [
        {
          "id": "e441721f-7369-4547-9aac-a278dfb74f05",
          "name": "Home Loan"
        }
      ],
      "business_terms": [
        {
          "id": "8d3641e9-841f-40d0-aa0b-f5e8e8b97186",
          "name": "Personal Information"
        }
      ],
      "catalog_assignments": [
        {
          "catalog": {
            "id": "33194072-e58e-476c-b094-412fd6e658d8",
            "name": "Very Enterprise Catalog"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "7a5d09ce-05a6-4f64-8a29-e9dee5f3a5b3"
        }
      ],
      "children": {
        "count": 0,
        "has_any": false,
        "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children"
      },
      "hierarchical_path": [
        {
          "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
          "name": "postgres",
          "type": "Database"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "s1",
          "type": "Schema"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "table1",
          "type": "Table"
        }
      ],
      "data_classes": [
        {
          "id": "3652f859-397e-4fa3-80ac-86e11a5379c4",
          "name": "First Name"
        }
      ],
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "is_deduced": false,
      "is_favorite": false,
      "name": "first_name",
      "project_assignments": [
        {
          "project": {
            "id": "ed99846a-2194-4826-9be5-0a805c811238",
            "name": "My Little Project"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "c4ce19e0-8ad4-42a6-9472-6290c92c8f0c"
        }
      ],
      "resource_key": "PostgreSQL/postgres/s1/table1/first_name",
      "tags": [
        "PII"
      ],
      "technology": {
        "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
        "name": "PostgreSQL"
      },
      "type": "Column"
    }
  ],
  "offset": 10,
  "limit": 5,
  "total_count": 15
}
Copy to clipboard

Get technology details based on the ID of the requested technology.

GET /gov_lineage/v2/technologies/{id}

Request

Path Parameters

id
Required*
string
Id of the requested technology

Response

Response Body

LineageTechnology

Type of system or a programming language that define the structure of lineage assets inside it

Status Code

200
Get successful
404
Entity not found

Example responses

Status 200

{
  "id": "2e2c6b2f5ad98d7d8d22baaf3b6df79298ed3b72db169ff3865400ecdae91972",
  "name": "PowerBI"
}
Copy to clipboard

Lists all technologies in the database

GET /gov_lineage/v2/technologies

Request

Query Parameters

name_prefix
string
Optional prefix of the name that filters the results. Only the technologies with the name starting with the prefix (case-insensitive) will be returned. If empty or not specified, all technologies are returned.

Possible values: 1 ≤ length ≤ 1024, Value must match regular expression ^.*$
order
string
Definition of order of the returned values (minus as a prefix means descending order). Use "name" or "-name".

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^-?[a-z_]+$
Default: name
Example: -name
offset
int32
The number of the first item in the page, starting from 0

Default: 0
limit
int32
Number of items being returned, must be 1 or higher

Possible values: value ≤ 1000
Default: 10

Response

Response Body

LineageTechnologyCollection

A slice of the result for getting technologies with information about its position in the ordered result
and access to other pages.

Status Code

200
Get successful

Example responses

Status 200

{
  "technologies": [
    {
      "id": "9202af6ce925b26ae6b25adfff0b2705147e195fa38dd58ae6ecc58ed263751f",
      "name": "Oracle"
    },
    {
      "id": "2e2c6b2f5ad98d7d8d22baaf3b6df79298ed3b72db169ff3865400ecdae91972",
      "name": "PowerBI"
    }
  ],
  "offset": 10,
  "limit": 5,
  "first": {
    "href": "https://something.ibm.com/gov_lineage/v2/technologies?offset=0&limit=5"
  },
  "last": {
    "href": "https://something.ibm.com/gov_lineage/v2/technologies?offset=25&limit=5"
  },
  "next": {
    "href": "https://something.ibm.com/gov_lineage/v2/technologies?offset=15&limit=5"
  },
  "previous": {
    "href": "https://something.ibm.com/gov_lineage/v2/technologies?offset=5&limit=5"
  },
  "total_count": 28
}
Copy to clipboard

List technology children based on the ID of the parent asset.

GET /gov_lineage/v2/technologies/{id}/children

Request

Path Parameters

id
Required*
string
Id of the parent lineage asset

Query Parameters

name_prefix
string
Optional prefix of the name that filters the results. Only the assets with the name starting with prefix (case-insensitive) will be returned. If empty or not specified, all children are returned.

Possible values: 1 ≤ length ≤ 1024, Value must match regular expression ^.*$
lineage_initial_asset_ids
string
If specified, the response should only contain assets that are part of lineage defined by the specified asset ids. It means that only assets that are accessible (directly or transitively) from the specified asset ids will be returned. The ids are divided by commas, their order isn't taken into account.

Possible values: 1 ≤ length ≤ 6499, Value must match regular expression ^[\da-f]+(,[\da-f]+)*$
order
string
Definition of order of the returned values (minus as a prefix means descending order). Use "name" or "-name".

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^-?[a-z_]+$
Default: name
Example: -name
allow_lineage_cache
boolean
If true, the lineage graph can be loaded from a cache. If false, the lineage graph must be recalculated from the current data. This parameter only makes sense when lineage_initial_asset_ids is specified.

Default: true
offset
int32
The number of the first item in the page, starting from 0

Default: 0
limit
int32
Number of items being returned, must be 1 or higher

Possible values: value ≤ 1000
Default: 10

Response

Response Body

LineageListChildrenResponse

A slice of the result for getting child assets with information about its position in the ordered result and access to other pages.

Status Code

200
Get successful
404
Entity not found

Example responses

Status 200

{
  "children": [
    {
      "attributes": [
        {
          "name": "COLUMN_CONSTRAINT",
          "value": "primary key"
        }
      ],
      "business_classifications": [
        {
          "id": "e441721f-7369-4547-9aac-a278dfb74f05",
          "name": "Home Loan"
        }
      ],
      "business_terms": [
        {
          "id": "8d3641e9-841f-40d0-aa0b-f5e8e8b97186",
          "name": "Personal Information"
        }
      ],
      "catalog_assignments": [
        {
          "catalog": {
            "id": "33194072-e58e-476c-b094-412fd6e658d8",
            "name": "Very Enterprise Catalog"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "7a5d09ce-05a6-4f64-8a29-e9dee5f3a5b3"
        }
      ],
      "children": {
        "count": 0,
        "has_any": false,
        "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children"
      },
      "hierarchical_path": [
        {
          "id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
          "name": "postgres",
          "type": "Database"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "s1",
          "type": "Schema"
        },
        {
          "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
          "name": "table1",
          "type": "Table"
        }
      ],
      "data_classes": [
        {
          "id": "3652f859-397e-4fa3-80ac-86e11a5379c4",
          "name": "First Name"
        }
      ],
      "id": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "is_deduced": false,
      "is_favorite": false,
      "name": "first_name",
      "project_assignments": [
        {
          "project": {
            "id": "ed99846a-2194-4826-9be5-0a805c811238",
            "name": "My Little Project"
          },
          "data_quality": {
            "score": 83.5
          },
          "cams_asset_id": "c4ce19e0-8ad4-42a6-9472-6290c92c8f0c"
        }
      ],
      "resource_key": "PostgreSQL/postgres/s1/table1/first_name",
      "tags": [
        "PII"
      ],
      "technology": {
        "id": "cc52d03280b7034c8e3653d2748ebd489a873ef4bbc89cb187fbfcabfbbf6873",
        "name": "PostgreSQL"
      },
      "type": "Column"
    }
  ],
  "offset": 10,
  "limit": 5,
  "first": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children?offset=0&limit=5"
  },
  "last": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children?offset=25&limit=5"
  },
  "next": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children?offset=15&limit=5"
  },
  "previous": {
    "href": "https://something.ibm.com/gov_lineage/v2/lineage_assets/d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35/children?offset=5&limit=5"
  },
  "total_count": 28
}
Copy to clipboard

Delete lineage for a licensing source by {licensing_source_id}. Licensing source entails a particular technology of a given data source definition.

POST /gov_lineage/v2/licensing_sources/{licensing_source_id}/delete_lineage

Request

Path Parameters

licensing_source_id
Required*
string
Licensing source id

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[\w-]+$
Example: 9b8b9f816550ac08e6eae8b1ebf452c010cce7919311b2519ec85e6083119909

Response

Status Code

202
Delete lineage for a licensing source by {licensing_source_id} started
401
Unauthorized
403
Forbidden. The user must have a proper role assigned to access this resource
404
Entity not found

No Sample Response

This method does not specify any sample responses.

Get a licensing source by {licensing_source_id}

GET /gov_lineage/v2/licensing_sources/{licensing_source_id}

Request

Path Parameters

licensing_source_id
Required*
string
Licensing source id

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[\w-]+$
Example: 9b8b9f816550ac08e6eae8b1ebf452c010cce7919311b2519ec85e6083119909

Response

Response Body

LineageLicensingSource

Licensing source

Contains a licensing usage for a particular data source definition and a technology combination.

Status Code

200
Get successful
404
Entity not found

Example responses

Status 200

{
  "id": "9b8b9f816550ac08e6eae8b1ebf452c010cce7919311b2519ec85e6083119909",
  "data_source_definition_asset_id": "948c2516-0823-4da0-b74a-9737329d136f",
  "data_source_definition_asset_name": "My MSSQL 1",
  "last_updated_timestamp": 1704067200000,
  "technology_name": "mssql",
  "usage": {
    "lineage_assets_count": 300000,
    "sources_count": 1,
    "tables_count": 30000
  },
  "status": "active"
}
Copy to clipboard

List licensing sources

GET /gov_lineage/v2/licensing_sources

Request

Query Parameters

order
string
Definition of order of the returned values (minus as a prefix means descending order). Use "lineage_assets_count" or "-lineage_assets_count".

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^-?[a-z_]+$
Default: -lineage_assets_count
Example: -lineage_assets_count
offset
int32
The number of the first item in the page, starting from 0

Default: 0
limit
int32
Number of items being returned, must be 1 or higher

Possible values: value ≤ 1000
Default: 10

Response

Response Body

LineageLicensingSourceCollection

Licensing source collection

Status Code

200
Get successful

Example responses

Status 200

{
  "licensing_sources": [
    {
      "id": "9b8b9f816550ac08e6eae8b1ebf452c010cce7919311b2519ec85e6083119909",
      "data_source_definition_asset_id": "948c2516-0823-4da0-b74a-9737329d136f",
      "data_source_definition_asset_name": "My MSSQL 1",
      "last_updated_timestamp": 1704067200000,
      "technology_name": "mssql",
      "usage": {
        "lineage_assets_count": 300000,
        "sources_count": 1,
        "tables_count": 30000
      },
      "status": "active"
    }
  ],
  "offset": 10,
  "limit": 5,
  "first": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_sources?offset=0&limit=5"
  },
  "last": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_sources?offset=25&limit=5"
  },
  "next": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_sources?offset=15&limit=5"
  },
  "previous": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_sources?offset=5&limit=5"
  },
  "total_count": 28
}
Copy to clipboard

This operation allows users to search for licensing sources using different filtering options and parameters.

POST /gov_lineage/v2/search_licensing_sources

Request

Request Body

Required*

LineageSearchLicensingRequest

Request for licensing search

Response

Response Body

LineageLicensingSourceCollection

Licensing source collection

Status Code

200
Get successful
404
Entity not found

Example responses

Status 200

{
  "licensing_sources": [
    {
      "id": "9b8b9f816550ac08e6eae8b1ebf452c010cce7919311b2519ec85e6083119909",
      "data_source_definition_asset_id": "948c2516-0823-4da0-b74a-9737329d136f",
      "data_source_definition_asset_name": "My MSSQL 1",
      "last_updated_timestamp": 1704067200000,
      "technology_name": "mssql",
      "usage": {
        "lineage_assets_count": 300000,
        "sources_count": 1,
        "tables_count": 30000
      },
      "status": "active"
    }
  ],
  "offset": 10,
  "limit": 5,
  "first": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_sources?offset=0&limit=5"
  },
  "last": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_sources?offset=25&limit=5"
  },
  "next": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_sources?offset=15&limit=5"
  },
  "previous": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_sources?offset=5&limit=5"
  },
  "total_count": 28
}
Copy to clipboard

Get a licensing summary

GET /gov_lineage/v2/licensing_summary

Request

No Request Parameters

This method does not accept any request parameters.

Response

Response Body

LineageLicensingSummary

Licensing summary

Contains a licensing usage and a licensing compliance with the tenant licensing configuration and the tenant entitlement.

Status Code

200
Get successful

Example responses

Status 200

{
  "usage": {
    "lineage_assets_count": 300000,
    "sources_count": 1,
    "tables_count": 30000
  }
}
Copy to clipboard

Get a licensing technology by {licensing_technology_id}

GET /gov_lineage/v2/licensing_technologies/{licensing_technology_id}

Request

Path Parameters

licensing_technology_id
Required*
string
Licensing technology id

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[\w-]+$
Example: 9b8b9f816550ac08e6eae8b1ebf452c010cce7919311b2519ec85e6083119909

Response

Response Body

LineageLicensingTechnology

Licensing technology

Contains a licensing usage for a particular technology.

Status Code

200
Get successful
404
Entity not found

Example responses

Status 200

{
  "id": "9b8b9f816550ac08e6eae8b1ebf452c010cce7919311b2519ec85e6083119909",
  "technology_name": "mssql",
  "usage": {
    "lineage_assets_count": 300000,
    "sources_count": 1,
    "tables_count": 30000
  },
  "status": "active"
}
Copy to clipboard

List licensing technologies

GET /gov_lineage/v2/licensing_technologies

Request

Query Parameters

order
string
Definition of order of the returned values (minus as a prefix means descending order). Use "lineage_assets_count" or "-lineage_assets_count".

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^-?[a-z_]+$
Default: -lineage_assets_count
Example: -lineage_assets_count
offset
int32
The number of the first item in the page, starting from 0

Default: 0
limit
int32
Number of items being returned, must be 1 or higher

Possible values: value ≤ 1000
Default: 10

Response

Response Body

LineageLicensingTechnologyCollection

Licensing technology collection

Status Code

200
Get successful

Example responses

Status 200

{
  "licensing_technologies": [
    {
      "id": "9b8b9f816550ac08e6eae8b1ebf452c010cce7919311b2519ec85e6083119909",
      "technology_name": "mssql",
      "usage": {
        "lineage_assets_count": 300000,
        "sources_count": 1,
        "tables_count": 30000
      },
      "status": "active"
    }
  ],
  "offset": 10,
  "limit": 5,
  "first": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_technologies?offset=0&limit=5"
  },
  "last": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_technologies?offset=25&limit=5"
  },
  "next": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_technologies?offset=15&limit=5"
  },
  "previous": {
    "href": "https://something.ibm.com/gov_lineage/v2/licensing_technologies?offset=5&limit=5"
  },
  "total_count": 28
}
Copy to clipboard

Retrieves credentials for accessing Cloud Object Storage bucket. Credentials are global for the tenant, all scans use this single bucket to store extracted data and load them during analysis. Objects in the bucket are managed by the IBM Manta Data Lineage Scanner Service and user should not modify them.

GET /gov_lineage/v2/cos_bucket_credentials

Request

No Request Parameters

This method does not accept any request parameters.

Response

Response Body

ScannerBucketCredentialsWithoutSecrets

Credentials needed to connect to Cloud Object Storage bucket, excluding secrets.

Status Code

200
Success. Returned information of the COS bucket credentials.
400
Bad request. One of the fields has invalid format/content.
401
Unauthorized. No/Malformed authentication provided.
403
Forbidden. User is not allowed to perform the target operation.
404
Not found. Item with the provided identifier is not available.

Example responses

Status 200

{
  "bucket_name": "cosbucket-lineage-f1749cd3-3b32-4975-8038-bfda7cee5d4f",
  "endpoint_url": "https://s3.us-west.cloud-object-storage.test.appdomain.cloud",
  "resource_instance_id": "beb6b4bf-1aba-4d51-b72c-167aedc47cad"
}
Copy to clipboard

Status 400: Bad Request error with status code 400

{
  "trace": "02eb5b72-8a22-438e-9996-4f4df8734f8c",
  "errors": [
    {
      "code": "bad_request",
      "message": "The `id` field needs to be a UUID v4, but is `12345`."
    }
  ]
}
Copy to clipboard

Status 401: Authentication error with status code 401

{
  "trace": "f41fc6f6-2e49-4224-bf7f-3d248c46d98d",
  "errors": [
    {
      "code": "invalid_auth_token",
      "message": "The IAM bearer token is not valid."
    }
  ]
}
Copy to clipboard

Status 403: Authorization error with status code 403

{
  "trace": "887d1782-b3cc-42ce-98eb-6a3ab7aac551",
  "errors": [
    {
      "code": "endpoint_access_forbidden",
      "message": "Jan.Novak@ibm.com is neither admin of the extraction Agent b275be5f-10ff-47ee-bfc9-63f1ce5addbf nor allowlisted user."
    }
  ]
}
Copy to clipboard

Status 404: Not Found error with status code 404

{
  "trace": "24dac0d5-a62d-4315-be6a-2cce1ec73972",
  "errors": [
    {
      "code": "not_found",
      "message": "Resource with the identifier `64697261-70ab-465c-acf0-bfe301670e2b` was not found."
    }
  ]
}
Copy to clipboard

Creates new credentials for accessing Cloud Object Storage bucket. The bucket must be already existing and the passed credentials needs permissions to create, get and delete objects in the bucket. Credentials are global for the tenant, all scans use this single bucket to store extracted data and load them during analysis. Objects in the bucket are managed by the IBM Manta Data Lineage Scanner Service and user should not modify them.

POST /gov_lineage/v2/cos_bucket_credentials

Request

Request Body

Required*

ScannerBucketCredentials

All credentials necessary to access a COS bucket.

Response

Response Body

ScannerBucketCredentials

Credentials needed to connect to Cloud Object Storage bucket.

Status Code

201
Success. Returned information of the created credentials.
400
Bad request. One of the fields has invalid format/content.
401
Unauthorized. No/Malformed authentication provided.
403
Forbidden. User is not allowed to perform the target operation.

Example responses

Status 201

{
  "api_key": "g_Gdxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "bucket_name": "cosbucket-lineage-f1749cd3-3b32-4975-8038-bfda7cee5d4f",
  "endpoint_url": "https://s3.us-west.cloud-object-storage.test.appdomain.cloud",
  "resource_instance_id": "beb6b4bf-1aba-4d51-b72c-167aedc47cad"
}
Copy to clipboard

Status 400: Bad Request error with status code 400

{
  "trace": "02eb5b72-8a22-438e-9996-4f4df8734f8c",
  "errors": [
    {
      "code": "bad_request",
      "message": "The `id` field needs to be a UUID v4, but is `12345`."
    }
  ]
}
Copy to clipboard

Status 401: Authentication error with status code 401

{
  "trace": "f41fc6f6-2e49-4224-bf7f-3d248c46d98d",
  "errors": [
    {
      "code": "invalid_auth_token",
      "message": "The IAM bearer token is not valid."
    }
  ]
}
Copy to clipboard

Status 403: Authorization error with status code 403

{
  "trace": "887d1782-b3cc-42ce-98eb-6a3ab7aac551",
  "errors": [
    {
      "code": "endpoint_access_forbidden",
      "message": "Jan.Novak@ibm.com is neither admin of the extraction Agent b275be5f-10ff-47ee-bfc9-63f1ce5addbf nor allowlisted user."
    }
  ]
}
Copy to clipboard

Deletes all metadata for the data source definition with the specified identifier for the specified scanner. This does not delete the data source definition itself, rather just its metadata collected by Scanner Service during scans of such a data source using the specified scanner. All running scans of the specified scanner for the specified data source definition will be terminated.

DELETE /gov_lineage/v2/data_source_definitions/{id}/scanners/{scanner}

Request

Path Parameters

id
Required*
string
The data source definition asset identifier.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example: c368a168-d4ea-4cdd-b058-11e8798c9864
scanner
Required*
string
The name of the scanner.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[ -~]+$
Example: Microsoft SQL Server

Response

Status Code

204
Success. The metadata for the data source definition were deleted.
400
Bad request. One of the fields has invalid format/content.
401
Unauthorized. No/Malformed authentication provided.
403
Forbidden. User is not allowed to perform the target operation.
404
Not found. Item with the provided identifier is not available.

Example responses

Status 400: Bad Request error with status code 400

{
  "trace": "02eb5b72-8a22-438e-9996-4f4df8734f8c",
  "errors": [
    {
      "code": "bad_request",
      "message": "The `id` field needs to be a UUID v4, but is `12345`."
    }
  ]
}
Copy to clipboard

Status 401: Authentication error with status code 401

{
  "trace": "f41fc6f6-2e49-4224-bf7f-3d248c46d98d",
  "errors": [
    {
      "code": "invalid_auth_token",
      "message": "The IAM bearer token is not valid."
    }
  ]
}
Copy to clipboard

Status 403: Authorization error with status code 403

{
  "trace": "887d1782-b3cc-42ce-98eb-6a3ab7aac551",
  "errors": [
    {
      "code": "endpoint_access_forbidden",
      "message": "Jan.Novak@ibm.com is neither admin of the extraction Agent b275be5f-10ff-47ee-bfc9-63f1ce5addbf nor allowlisted user."
    }
  ]
}
Copy to clipboard

Status 404: Not Found error with status code 404

{
  "trace": "24dac0d5-a62d-4315-be6a-2cce1ec73972",
  "errors": [
    {
      "code": "not_found",
      "message": "Resource with the identifier `64697261-70ab-465c-acf0-bfe301670e2b` was not found."
    }
  ]
}
Copy to clipboard

Introduction to IBM Manta Data Lineage as a Service

Endpoint URL

Authentication

Error handling

Related APIs

Methods

Get lineage asset by ID

Request

Path Parameters

id

Response

Response Body

id

hierarchical_path

tags

attributes

business_terms

business_classifications

data_classes

catalog_assignments

project_assignments

name

type

identity_key

resource_key

children

technology

is_favorite

is_deduced

Status Code

200

404

Update lineage asset

Request

Path Parameters

id

Request Body

is_favorite

Response

Response Body

id

hierarchical_path

tags

attributes

business_terms

business_classifications

data_classes

catalog_assignments

project_assignments

name

type

identity_key

resource_key

children

technology

is_favorite

is_deduced

Status Code

200

404

List lineage asset children

Request

Path Parameters

id

Query Parameters

name_prefix

lineage_initial_asset_ids

order

allow_lineage_cache

offset

limit

Response

Response Body

offset

limit

total_count

children

first

last

previous