Add relation in existing Assets using the collibra-integration-library 1.0.2 API

Question

Hi @spring-team.collibra.com ,
Can someone guide me how can i fetch the existing asset from collibra and add the relation to that. i am using spring boot application to do this. Please refer below screenshot

Thanks in advance.

springboot_team · Answer

Hello Pratik,

Just to let you know that the updated version of the Spring Boot Integration Library, having version 1.1.4, has been released and is available on Collibra’s Marketplace.

Spring Boot Integration Library - Collibra Marketplace

Java classes to facilitate access to Collibra APIs.

springboot_team · Answer

Hello Pratik,

A new version of the Spring Boot Integration Library should be released this week, while the Collibra instances will be upgraded later on.

Just to note that once the Spring Boot Integration Library is released, it should also work with instances having build number 20220302161146. Thank you

pratikmori · Answer

Hi @spring-team.collibra.com , Thanks for letting us know, is there any ETA ? Thanks, Pratik

springboot_team · Answer

Hello Pratik,

Just to keep you updated the a new version of the Collibra Integration Library will be released to address this issue when connecting with instances having build number 20220302161146.

Thank you

pratikmori · Answer

Hi @spring-team.collibra.com , We have raise the ticket as per them it is a known issue, Below response we got from them . "A Workaround for the issue would be to use a cookie-based session. When JSESSIONID cookie is set, then a csrfToken is returned." Do you have any workaround available. Thanks, Pratik

pratikmori · Answer

Sure @spring-team.collibra.com , Will do as you suggested. Thanks For guiding us Really appreciate

springboot_team · Answer

Hello Pratik, Thanks for checking. Regarding the missing CSRF token as part of the login request, can you please open a support ticket with Collibra?

pratikmori · Answer

Hi @spring-team.collibra.com , Please refer below screenshot. I can see JSESSIONID but not CSRF Token and Response body as you mentioned it is {} . Thanks, Pratik

springboot_team · Answer

Hello Pratik,

Thanks for the checking.

What needs to be confirmed is for the specified request (screenshot) what is returned as a response please?
That is, whether the response body contains a {} or a csrfToken key with a non-empty value or something else.

Additionally, whether the response headers contain a JSESSIONID cookie with a non-empty value.

springboot_team · Answer

Hello Pratik,

Thanks for the update.

The Collibra Integration Library internally makes use of the Collibra REST APIs to communicate with the instance. One of the first requests made is to login to the Collibra instance and retrieve a session ID and a CSRF token.

To confirm/check whether the instance is returning this information for this login request, would it be possible to test the cURL request in the previous post please? Thank you

springboot_team · Answer

Hello Pratik,

Thanks for the update.

The Collibra Integration Library internally makes use of the Collibra REST APIs to communicate with the instance. One of the first requests made is to login to the Collibra instance and retrieve a session ID and a CSRF token.

To confirm/check whether the instance is returning this information for this login request, would it be possible to test the cURL request in the previous post please? Thank you

springboot_team · Answer

Hello Pratik,

Thanks for confirming this.

The issue could be that the response of the login request (HTTP POST /rest/2.0/auth/sessions) sent to the Collibra instance API does not contain the CSRF token. (Similar to this post.)

Since the error is a bit different, can you please check whether the response of the following cURL request is a {} or whether it contains a csrfToken key? Thank you

curl -X POST \
  https://<your_dgc_environment_url>/rest/2.0/auth/sessions \
  -H 'Content-Type: application/json' \
  -d '{
	"username": "<user_name>",
	"password": "<password>"
}'

where:

<your_dgc_environment_url> should be replaced with the Collibra instance URL
<user_name> should be replaced with the respective Collibra username
<password> should be replaced with the respective Collibra password

For more information, you can also refer to: https://developer.collibra.com/developer-tutorials/rest-api-authentication/

springboot_team · Answer

Hello Pratik,

Thanks for confirming this.

The issue could be that the response of the login request (HTTP POST /rest/2.0/auth/sessions) sent to the Collibra instance API does not contain the CSRF token. (Similar to this post.)

Since the error is a bit different, can you please check whether the response of the following cURL request is a {} or whether it contains a csrfToken key? Thank you

curl -X POST \
  https://<your_dgc_environment_url>/rest/2.0/auth/sessions \
  -H 'Content-Type: application/json' \
  -d '{
	"username": "<user_name>",
	"password": "<password>"
}'

where:

<your_dgc_environment_url> should be replaced with the Collibra instance URL
<user_name> should be replaced with the respective Collibra username
<password> should be replaced with the respective Collibra password

For more information, you can also refer to: https://developer.collibra.com/developer-tutorials/rest-api-authentication/

springboot_team · Answer

Hello Pratik, Regarding the error encountered, can you please check whether your Collibra instance version has build number 20220302161146? Thank you

springboot_team · Answer

Hello Pratik, Regarding the error encountered, can you please check whether your Collibra instance version has build number 20220302161146? Thank you

pratikmori · Answer

Thanks , It is working now

pratikmori · Answer

Thanks , It is working now

springboot_team · Answer

Hello Pratik,

The issue could be that when calling the findAssetByName method, the root community name is being passed instead of the name of the community that is the direct parent of the domain.

As an example, assuming the following structure:

Root Community
- Child Community
  - Domain

When calling this method, the “Child Community” and “Domain” should be specified.

pratikmori · Answer

Hi @spring-team.collibra.com , Thanks For Clarifying. As of now i am using AssetImpl as= collibraCoreApiHelper.findAssetByName( assertFullname,DomainName,CommunityName) but here i found one scenario where this method is not working . If we have one child community and inside the child community we have a domain then method is returning NULL response. if i have only top level community and domain inside that community then this method is working fine. Do you have any idea why first scenario is failing ? Thanks, Pratik

springboot_team · Answer

Hello Pratik,

To retrieve details of an asset using the CLI generated functions based on its resource ID, it can be achieved as follows (as specified in section “The Collibra CLI Generated Functions” of the documentation).

private final ApiClient apiClient;

@Autowired
public Constructor(ApiClient apiClient){
    this.apiClient = apiClient;
}

...

AssetsApi assetsApi = apiClient.buildClient(AssetsApi.class);
AssetImpl myAssetDetails = assetsApi.getAsset(myAssetId);
String assetDisplayName = myAssetDetails.getDisplayName();

On the other hand to retrieve the details of all assets having type Report from a specific Collibra Platform instance domain, the export functionality should be used.

To do so, a TableViewConfig similar to the one attached can be used. (For more information on building the TableViewConfig, please refer to https://collibra-developer-portal.s3-eu-west-1.amazonaws.com/docs/output-module/Content/OutputModule/co_getting-started.htm ). Subsequently, the CollibraExportApiHelper may be used to submit the request to the Collibra Platform API (as specified in the documentation, section “The CollibraExportApiHelper Class”).

tvg-sample.txt (1.8 KB)

springboot_team · Answer

Hello Pratik,

Thanks for trying the Spring Boot Integration Library.

Assuming that the asset identifier (e.g. the asset full name) is known, this could be achieved by using the CollibraImportApiHelper class as specified in the library documentation section “A Step-by-Step Guide to Importing/Upserting Assets”, sub-section “The Asset Relations”.

Example:

CollibraAsset columnAsset = new CollibraAsset.Builder()
        .name(assetName)
        .type(CollibraConstants.AssetType.COLUMN)
        .domainNameAndCommunityName(collibraDomainName, collibraCommunityName)
        .addRelation(
            CollibraConstants.RelationType.COLUMN_ISPARTOF_TABLE,
            CollibraRelation.Direction.TARGET,
            new CollibraRelation.Builder()
                .relatedAssetId(tableAssetId)
                .build()
        )
        .build();

If only one asset needs to be retrieved prior to adding the relation, this can be achieved through the CLI generated functions (section “The Collibra CLI Generated Functions”) or for multiple assets the export functionality of the Collibra Platform instance that exports assets based on a TableViewConfig (section “The CollibraExportApiHelper Class”) can be used.

springboot_team · Answer

Hello Pratik,

Thanks for trying the Spring Boot Integration Library.

Assuming that the asset identifier (e.g. the asset full name) is known, this could be achieved by using the CollibraImportApiHelper class as specified in the library documentation section “A Step-by-Step Guide to Importing/Upserting Assets”, sub-section “The Asset Relations”.

Example:

CollibraAsset columnAsset = new CollibraAsset.Builder()
        .name(assetName)
        .type(CollibraConstants.AssetType.COLUMN)
        .domainNameAndCommunityName(collibraDomainName, collibraCommunityName)
        .addRelation(
            CollibraConstants.RelationType.COLUMN_ISPARTOF_TABLE,
            CollibraRelation.Direction.TARGET,
            new CollibraRelation.Builder()
                .relatedAssetId(tableAssetId)
                .build()
        )
        .build();

If only one asset needs to be retrieved prior to adding the relation, this can be achieved through the CLI generated functions (section “The Collibra CLI Generated Functions”) or for multiple assets the export functionality of the Collibra Platform instance that exports assets based on a TableViewConfig (section “The CollibraExportApiHelper Class”) can be used.

1	Grant Rollerson SUNCORP CORPORATE SERVICES PTY LTD
2	Tom Friesen Algonquin College
3	SB S Benson Plus3 IT
4	S stefan_busch
5	Brian Lloyd USA TODAY Co.
6	D daverichard