Collibra Data Governance Center Connector. This version is compatible with Data Governance Center 5.1.x and above and not compatible with Data Governance Center 5.0.x and below. This connector is using both: versions (version 1 and version 2) of the public REST API to perform communication with selected DGC instance. Define a java system property 'com.collibra.dgc.rest.client.debug=true' to see the exact calls that are made with each call. The connector makes use of the ConnectionStrategy to 'login' and store the open session. Re-using the open session is carried out automatically and no longer requires the 'login' method to be called before the beginning of a flow. For backwards compatibility, each method still accepts a 'sessionId' argument. If the arugment's value provided is equal to the one that is in the connectionStrategy or null, the ConnectionStrategy class returns the client instance. Otherwise, it throws an IllegalArgumentException.

Additional Info

Requires Mule Enterprise License

No  

Requires Entitlement

No  

Mule Version

3.5.0 or higher

Configs

Connection Managament type strategy

<collibra-dgc:config>

Connection Management

Defines parameters of the connection. Clicking "Test Connection..." will perform login (1.0/user/login), version check (1.0/application/version) and logout (1.0/user/logout).

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

A username

x 

password

String

A password

x 

baseApplicationUrl

String

Base url of Collibra DGC application. Example: http://localhost:8080/dgc.

http://localhost:8080/dgc

 

proxyHostName

String

The property defines a host of a HTTP proxy the connector should use. Example proxyname.collibra.com.

 

proxyPort

Integer

The property defines a port of a HTTP proxy the connector should use.

 

proxyUsername

String

The property defines a user name which will be used for HTTP proxy authentication. The property is ignored if no HTTP proxyHostName has been set.

 

proxyPassword

String

The property defines a user password which will be used for HTTP proxy authentication. The property is ignored if no HTTP proxyHostName has been set.

 

overridePUTAndDELETEWithPOST

Boolean

If set to true - all PUT and DELETE HTTP methods to be replaced by POST.

false

 

maxRetry

Integer

Number of retry attempts for retryable exceptions

0

 

bypassSSLValidation

Boolean

Bypass SSL Validation

false

 

Processors

Login

<collibra-dgc:login>

Performs login (2.0/auth/sessions) to start a new session and retrieve JSESSIONID cookie. Cookie is automatically set to #[sessionVars.dgcSessionId] for backwards compatibility. Additionally if CSRF token is enabled in DGC this operation will store the retrieved CSRF token in #[sessionVars.dgcCsrfToken] variable. Because all operations by default check this property it will be automatically propagated and passed to the subsequent operations using this session variable.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

String

value of the JSESSIONID cookie of a started session.

Logout

<collibra-dgc:logout>

Performs logout (2.0/auth/sessions/current) to end the session.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Add community

<collibra-dgc:add-community>

Adds the community

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addCommunityRequest

AddCommunityRequest

- object of type AddCommunityRequest describing the Community.

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Community

the new Community type object

Get community

<collibra-dgc:get-community>

Gets the Community by ID

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

communityId

String

- the id of the Community

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Community

the Community type object when found

Get community by name

<collibra-dgc:get-community-by-name>

Gets the Community by name

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

communityName

String

- the name of the Community

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Community

the Community type object when found

Change community

<collibra-dgc:change-community>

Changes the specific Community

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeCommunityRequest

ChangeCommunityRequest

- object of type ChangeCommunityRequest describing the Community.

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Community

the modified Community type object

Remove community

<collibra-dgc:remove-community>

Removes the Community

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

communityId

String

- the id of the Community

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Add domain

<collibra-dgc:add-domain>

Adds the new Domain

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addDomainRequest

AddDomainRequest

- object of type AddDomainRequest describing the Domain.

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Domain

the new Domain type object

Get domain

<collibra-dgc:get-domain>

Gets the Domain by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

domainId

String

- the id of the Domain

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Domain

the Domain type object when found

Get domain by name

<collibra-dgc:get-domain-by-name>

Gets the Domain by name from specific Community

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

communityId

String

- the id of the Community that owns the Domain

x 

domainName

String

- the name of the Domain

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Domain

the Domain type object when found

Change domain

<collibra-dgc:change-domain>

Change the specific Domain

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeDomainRequest

ChangeDomainRequest

- object of type ChangeDomainRequest describing the Domain.

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Domain

the modified Domain type object

Remove domain

<collibra-dgc:remove-domain>

Removes the specific Domain

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

domainId

String

- the id of the Domain

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Remove domains

<collibra-dgc:remove-domains>

Removes Domains

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

domainIds

List<String>

- Ids of domains to be removed

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

List assets

<collibra-dgc:list-assets>

  Paged Operation

Returns the list of the Assets from specific Domain

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

domainId

String

- the id of the Domain

x 

pagingConfiguration

PagingConfiguration

- the query pagination configuration

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Asset,CollibraDGCConnector>

the list of the Assets

List Assets By Asset Type, and Last Modified Date

<collibra-dgc:list-assets-by-asset-type-and-last-modified-date>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assetType

String

- The asset Type

x 

lastModifiedDate

long

- The last Modified date

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- The csrfToken

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

List<Asset>

List of Asset

Add asset

<collibra-dgc:add-asset>

Adds the Asset

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addAssetRequest

AddAssetRequest

- object of type AddAssetRequest describing the Asset

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Asset

the new Asset type object

Get asset

<collibra-dgc:get-asset>

Gets the Asset by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assetId

String

- the id of the Asset

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Asset

the Asset type object when found

Get asset by external entity id

<collibra-dgc:get-asset-by-external-id>

Get asset by external entity ID.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

externalId

String

- the ID of an external entity (entity from another system) that was created for an Asset in DGC.

x 

externalSystemId

String

- the id of the external system

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Asset

the Asset type object when found

Get asset by name

<collibra-dgc:get-asset-by-name>

Gets the asset by name from specific Domain

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

domainId

String

- the id of the Domain that owns the Asset

x 

assetName

String

- the name of the Asset

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Asset

the Asset type object when found

Change asset

<collibra-dgc:change-asset>

Changes the specific Asset

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeAssetRequest

ChangeAssetRequest

- the object of type ChangeAssetRequest describing the Asset

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Asset

the modified Asset type object

Remove asset

<collibra-dgc:remove-asset>

Removes the specific Asset

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assetId

String

- the id of the Asset

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Remove assets

<collibra-dgc:remove-assets>

Removes Assets

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assetIds

List<String>

- Ids of assets to be removed

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Add user

<collibra-dgc:add-user>

Adds user

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addRequest

AddUserRequest

- object of type AddUserRequest describing the user to be added.

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

User

the new UserReference type object

Get user

<collibra-dgc:get-user>

Gets the user by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

- the id of the User

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

User

the UserReference type object when found

Change user

<collibra-dgc:change-user>

Changes the specific User NOTE: changing userName is no longer supported. (API V2 limitation)

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeUserRequest

ChangeUserRequest

- the object of type ChangeUserRequest describing the User

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

User

the modified UserReference type object

Remove user

<collibra-dgc:remove-user>

Removes the specific User Still using V1 of the API

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

- the id of the User

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Add relation

<collibra-dgc:add-relation>

Adds the Relation between assets

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addRelationRequest

AddRelationRequest

- object of type AddRelationRequest describing the Relation

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Relation

the new Relation type object

Get relation

<collibra-dgc:get-relation>

Gets the Relation by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

relationId

String

- the id of the Relation

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Relation

the Asset type object when found

Change relation

<collibra-dgc:change-relation>

Changes the Relation

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeRelationRequest

ChangeRelationRequest

- object of type ChangeRelationRequest describing the Relation

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Relation

the modified Relation type object

Remove relation

<collibra-dgc:remove-relation>

Removes the Relation

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

relationId

String

- the id of the Relation

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Find relations

<collibra-dgc:find-relations>

  Paged Operation

Gets the Relations of desired type between selected assets

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

findRelationsRequest

FindRelationsRequest

- object of type FindRelationsRequest describing the Relations

#[payload]

 

pagingConfiguration

PagingConfiguration

- the query pagination configuration

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Relation,CollibraDGCConnector>

the relations list

Add comment

<collibra-dgc:add-comment>

Adds a Comment into a resource

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addCommentRequest

AddCommentRequest

- object of type AddCommentRequest describing the comment

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Comment

the new Comment type object

Add reply

<collibra-dgc:add-reply>

Post a reply to the Comment

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addReplyRequest

AddReplyRequest

- object of type AddReplyRequest describing the reply

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Comment

the new Comment type object

Get comment

<collibra-dgc:get-comment>

Gets a Comment by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

commentId

String

- the id of the Comment

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Comment

the Comment type object

Change comment

<collibra-dgc:change-comment>

Modifies the Comment

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeCommentRequest

ChangeCommentRequest

- object of type ChangeCommentRequest describing a comment

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Comment

the modified Comment type object

Remove comment

<collibra-dgc:remove-comment>

Removes the Comment

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

commentId

String

- the id of the Comment

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

List replies

<collibra-dgc:list-replies>

Gets list of replies for Comment

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

commentId

String

- the id of the Comment

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

List<Comment>

the list of the Comment type objects

List comments

<collibra-dgc:list-comments>

Gets a list of comments for selected Resource

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

resourceId

String

- the id of the Resource

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

List<Comment>

the list of the Comment type objects

Simulate CSV Import

<collibra-dgc:simulate-import-c-s-v>

Simulates import for CSV file. Import simulation is triggered using POST /input/csv/simulate. Then the job status is checked for completeness (each second for jobs under 10 seconds and each 10 seconds for longer jobs). If import is unsuccessful then a exception is thrown with the message containing 'state' and the 'message' properties of the job that was returned by the server.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

csvFileId

String

- the ID of CSV file uploaded to DGC, used to import

#[payload]

 

tableViewConfig

String

- JSON String representation of TableViewConfig

x 

separator

String

- the delimiter character used to separate entries

,

 

quote

String

- the delimiter character used for quoted entries

"

 

escape

String

- the delimiter character used to escape separator or quote character

\

 

strictQuotes

boolean

- set the character outside quotes are ignored (true) or not (false)

false

 

ignoreLeadingWhiteSpace

boolean

- set if white space before quotes are ignored (true) or not (false)

false

 

headerRow

boolean

- set if the first row of the sheet is the header (true) or not (false)

false

 

sendNotification

boolean

- true to send notification, false otherwise

false

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Job

the job with state and report message

Import CSV

<collibra-dgc:import-c-s-v>

Imports CSV file. Import is done in 3 steps. A file is uploaded using POST /file method. In next step an import is triggered using POST /input/csv. Then the job status is checked for completeness (each second for jobs under 10 seconds and each 10 seconds for longer jobs). If import is unsuccessful then a exception is thrown with the message containing 'state' and the 'message' properties of the job that was returned by the server.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

csvFile

InputStream

- the CSV file to import

#[payload]

 

csvFileId

String

- the ID of CSV file uploaded to DGC, used to import

 

csvFileName

String

- the optional name of the file to be uploaded

 

tableViewConfig

String

- JSON String representation of TableViewConfig

x 

separator

String

- the delimiter character used to separate entries

,

 

quote

String

- the delimiter character used for quoted entries

"

 

escape

String

- the delimiter character used to escape separator or quote character

\

 

strictQuotes

boolean

- set the character outside quotes are ignored (true) or not (false)

false

 

ignoreLeadingWhiteSpace

boolean

- set if white space before quotes are ignored (true) or not (false)

false

 

headerRow

boolean

- set if the first row of the sheet is the header (true) or not (false)

false

 

deleteFile

boolean

- true if the file must be deleted when the Job is terminated, false otherwise

false

 

sendNotification

boolean

- true to send a notification, false otherwise

false

 

waitForImportToFinish

boolean

- if true then this operation will trigger import job and return only when the job is finished (status will be checked by polling the running job). If false then this operation returns immediately after the import job is started

true

 

jobStatusCheckIntervalMilliseconds

Integer

- how often status of the job should be checked for completeness. This interval defines time (given in milliseconds) between two consecutive checks. If not provided then standard checking strategy applies (each second for jobs under 10 seconds and each 10 seconds for longer jobs)

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Job

the job with state and report message

Import CSV from string

<collibra-dgc:import-c-s-v-from-string>

Imports CSV file form a String argument. Import is done in 3 steps. A file is uploaded using POST /file method. In next step an import is triggered using POST /input/csv. Then the job status is checked for completeness (each second for jobs under 10 seconds and each 10 seconds for longer jobs). If import is unsuccessful then a exception is thrown with the message containing 'state' and the 'message' properties of the job that was returned by the server.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

stringCsvFile

String

- CVS file in string

#[payload]

 

fileName

String

- the optional name of the file to be uploaded

 

tableViewConfig

String

- JSON String representation of TableViewConfig

x 

separator

String

- the delimiter character used to separate entries

,

 

quote

String

- the delimiter character used for quoted entries

"

 

escape

String

- the delimiter character used to escape separator or quote character

\

 

strictQuotes

boolean

- set the character outside quotes are ignored (true) or not (false)

false

 

ignoreLeadingWhiteSpace

boolean

- set if white space before quotes are ignored (true) or not (false)

false

 

headerRow

boolean

- set if the first row of the sheet is the header (true) or not (false)

false

 

deleteFile

boolean

- true if the file must be deleted when the Job is terminated, false otherwise

false

 

sendNotification

boolean

- true to send a notification, false otherwise

false

 

waitForImportToFinish

boolean

- if true then this operation will trigger import job and return only when the job is finished (status will be checked by polling the running job). If false then this operation returns immediately after the import job is started

true

 

jobStatusCheckIntervalMilliseconds

Integer

- how often status of the job should be checked for completeness. This interval defines time (given in milliseconds) between two consecutive checks. If not provided then standard checking strategy applies (each second for jobs under 10 seconds and each 10 seconds for longer jobs)

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Simulate Excel Import

<collibra-dgc:simulate-import-excel>

Imports Excel file. Import is triggered using POST /input/excel/simulate. Then the job status is checked for completeness (each second for jobs under 10 seconds and each 10 seconds for longer jobs). If import is unsuccessful then a exception is thrown with the message containing 'state' and the 'message' properties of the job that was returned by the server.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

excelFileId

String

- the ID of Excel file uploaded to DGC, used to import

#[payload]

 

tableViewConfig

String

- JSON String representation of TableViewConfig

x 

headerRow

boolean

- set if the first row of the sheet is the header (true) or not (false)

false

 

sendNotification

boolean

- true to send a notification, false otherwise

false

 

sheetName

String

- the name of the sheet. If the name is null, the first sheet of the workbook will be used for the import

 

sheetIndex

Integer

- the index of the sheet (zero-based). If the index is null or negative, the first sheet of the workbook will be used for the import

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Job

the job with state and report message

Import Excel

<collibra-dgc:import-excel>

Imports Excel file. Import is done in 3 steps. A file is uploaded using POST /file method. In next step an import is triggered using POST /input/excel. Then the job status is checked for completeness (each second for jobs under 10 seconds and each 10 seconds for longer jobs). If import is unsuccessful then a exception is thrown with the message containing 'state' and the 'message' properties of the job that was returned by the server.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

excelFile

InputStream

- the Excel file to import

#[payload]

 

excelFileId

String

- the ID of Excel file uploaded to DGC, used to import

 

excelFileName

String

- the optional name of the file to be uploaded

 

tableViewConfig

String

- JSON String representation of TableViewConfig

x 

headerRow

boolean

- set if the first row of the sheet is the header (true) or not (false)

false

 

deleteFile

boolean

- true if the file must be deleted when the Job is terminated, false otherwise

false

 

sendNotification

boolean

- true to send a notification, false otherwise

false

 

sheetName

String

- the name of the sheet. If the name is null, the first sheet of the workbook will be used for the import

 

sheetIndex

Integer

- the index of the sheet (zero-based). If the index is null or negative, the first sheet of the workbook will be used for the import

 

waitForImportToFinish

boolean

- if true then this operation will trigger import job and return only when the job is finished (status will be checked by polling the running job). If false then this operation returns immediately after the import job is started

true

 

jobStatusCheckIntervalMilliseconds

Integer

- how often status of the job should be checked for completeness. This interval defines time (given in milliseconds) between two consecutive checks. If not provided then standard checking strategy applies (each second for jobs under 10 seconds and each 10 seconds for longer jobs)

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Job

the job with state and report message

Import Metrics

<collibra-dgc:import-metrics-from-c-s-v>

Imports metrics from CVS file. The POST request to /statistic/metric/upload resource is performed.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

metricsFile

InputStream

- the CVS file to import

#[payload]

 

fileName

String

- the optional name of the file to be uploaded

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Export CSV

<collibra-dgc:export-c-s-v>

Exports the table to CSV file.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

tableViewConfig

String

- JSON String representation of TableViewConfig

x 

file

String

- the name of the file or null to use a generated file name

 

separator

String

- the delimiter character used to separate entries

,

 

quote

String

- the delimiter character used for quoted entries

"

 

escape

String

- the delimiter character used to escape separator or quote character

\

 

headerRow

Boolean

- set if the file will include a header (true) or not (false)

true

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

InputStream

the exported CSV file

Export CSV as String

<collibra-dgc:export-c-s-v-as-string>

Exports the table in CSV format to String

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

tableViewConfig

String

- JSON String representation of TableViewConfig

x 

file

String

- the name of the file or null to use a generated file name

 

separator

String

- the delimiter character used to separate entries

,

 

quote

String

- the delimiter character used for quoted entries

"

 

escape

String

- the delimiter character used to escape separator or quote character

\

 

headerRow

Boolean

- set if the file will include a header (true) or not (false)

true

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

String

the CVS as String

Export Excel

<collibra-dgc:export-excel>

Exports the table to Excel file

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

tableViewConfig

String

- JSON String representation of TableViewConfig

x 

file

String

- the name of the file or null to use a generated file name

 

sheetName

String

- the name of the sheet or null if no sheet name has to be set

 

useXLSX

Boolean

- set if the Excel file to export will be .xlsx file (true) or a .xls file (false)

true

 

headerRow

Boolean

- set if the file will include a header (true) or not (false)

true

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

InputStream

the exported Excel file

Export JSON

<collibra-dgc:export-j-s-o-n>

Exports the table as JSON

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

tableViewConfig

String

- JSON String representation of TableViewConfig

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

InputStream

the exported JSON file

Download file

<collibra-dgc:download-file>

Download file content with given file's id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

- The id of the file [required]

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

InputStream

the InputStream to the file

Upload file

<collibra-dgc:upload-file>

Upload file to the temporary upload directory.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

file

InputStream

- the file to upload

#[payload]

 

fileName

String

- name of the file to be uploaded (optional)

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

String

If of the file

Add responsibility

<collibra-dgc:add-responsibility>

Adds a responsibility to the existing list of Responsibilities.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addResponsibilityRequest

AddResponsibilityRequest

- object of type AddResponsibilityRequest describing the responsibility

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Responsibility

an object of type Responsibility} based on the

Find responsibilities

<collibra-dgc:find-responsibility>

Gets the Responsibilities list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

findResponsibilityRequest

FindResponsibilityRequest

- object of type FindResponsibilityRequest describing the

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

List<Responsibility>

the list of the Responsibility type objects

Get status

<collibra-dgc:get-status>

Gets the Status by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

statusId

String

- the id of the Status

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Status

the Status type object describing the Status

Get status by name

<collibra-dgc:get-status-by-name>

Gets the Status by name

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

statusName

String

- the name of the Status

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Status

the Status type object describing the Status

Get attribute type

<collibra-dgc:get-attribute-type>

Gets the Attribute type by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

attributeTypeId

String

- the id of the Attribute

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

NamedResourceReference

the NamedResourceReference type object describing the

Get attribute type by name

<collibra-dgc:get-attribute-type-by-name>

Gets the Attribute Type by name

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

attributeTypeName

String

- the name of the Attribute

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

NamedResourceReference

the NamedResourceReference type object describing the

Get domain type

<collibra-dgc:get-domain-type>

Gets the domain Type by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

domainTypeId

String

- the id of the domain Type

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

NamedResourceReference

the NamedResourceReference type object describing the

Get domain type by name

<collibra-dgc:get-domain-type-by-name>

Gets domain Type by Type name

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

domainTypeName

String

- the name of the domain Type

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

NamedResourceReference

the NamedResourceReference type object describing the

Get asset type

<collibra-dgc:get-asset-type>

Gets the asset Type by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assetTypeId

String

- the id of the asset Type

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

NamedResourceReference

the NamedResourceReference type object describing the

Get asset type by name

<collibra-dgc:get-asset-type-by-name>

Gets the asset Type by name

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assetTypeName

String

- the name of the asset Type

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

NamedResourceReference

the NamedResourceReference type object describing the

Get relation type

<collibra-dgc:get-relation-type>

Gets the relation Type by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

relationTypeId

String

- the id of the relation Type

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

RelationType

the RelationType type object describing the relation Type

Add mapping

<collibra-dgc:add-mapping>

Adds mapping

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addMappingRequest

AddMappingRequest

- object of type AddMappingRequest describing the mapping

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Mapping

the Mapping type object describing the mapping

Get mapping

<collibra-dgc:get-mapping>

Gets the mapping by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

mappingId

String

- the id of the mapping

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Mapping

the Mapping type object describing the mapping

Remove mapping

<collibra-dgc:remove-mapping>

Removes the mapping

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

mappingId

String

- the id of the mapping

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Remove mapping by external entity id

<collibra-dgc:remove-mapping-ext-entity-id>

Removes the mapping identified by the external system id and external entity id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

extSystemId

String

- the id of the external system

x 

extEntityId

String

- the id of the the external entity

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Remove mapping by resource id

<collibra-dgc:remove-mapping-by-resource-id>

Removes the mapping identified by the external system id and resource id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

extSystemId

String

- the id of the external system

x 

resourceId

String

- the id of the Asset or Domain in DGC

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Remove all mappings to external system

<collibra-dgc:clean-mappings>

Removes all mappings for given external system

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

extSystemId

String

- the id of the external system

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Find mapping by external entity id

<collibra-dgc:find-mapping-by-ext-entity-id>

Gets a mapping identified by the external system id and external entity id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

extSystemId

String

- the id of the external system

x 

extEntityId

String

- the id of the external entity

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Mapping

the Mapping type object describing the mapping

Find mapping by resource id

<collibra-dgc:find-mapping-by-resource-id>

Gets a mapping identified by the external system id and resource id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

extSystemId

String

- the id of the external system

x 

resourceId

String

- the id of the Asset or Domain in DGC

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Mapping

the Mapping type object describing the mapping

Find mappings

<collibra-dgc:find-mappings>

  Paged Operation

Returns the mappings list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

findMappingRequest

FindMappingsRequest

- object of type FindMappingsRequest describing the mappings

#[payload]

 

pagingConfiguration

PagingConfiguration

- the query pagination configuration

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Mapping,CollibraDGCConnector>

the mappings list

Change mapping

<collibra-dgc:change-mapping>

Modifies the mapping

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeMappingRequest

ChangeMappingRequest

- object of type ChangeMappingRequest describing the mapping

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Mapping

the modified Mapping type object

Add attribute

<collibra-dgc:add-attribute>

Adds atrribute with given value to the Asset

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addAttributeRequest

AddAttributeRequest

- object of type AddAttributeRequest that represents the Attribute

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Attribute

the new Attribute type object

Add multivalue attribute

<collibra-dgc:add-multivalue-list-attribute>

Adds atribute with multiple values to the Asset

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addMultivalueAttributeRequest

AddMultivalueAttributeRequest

- object of type AddMultivalueAttributeRequest that represents the Attribute

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Attribute

the new Attribute type object

Get attribute

<collibra-dgc:get-attribute>

Gets the attribute by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

attributeId

String

- the id of the attribute

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Attribute

the Attribute type object

Find attributes

<collibra-dgc:find-attributes>

Gets list of the attributes for selected resource

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

findAttributesRequest

FindAttributesRequest

- object of type FindAttributesRequest that represents the querry

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

List<Attribute>

the list of the Attribute type objects that represents

Change attribute

<collibra-dgc:change-attribute>

Makes changes to an attribute that is already in the list of attributes.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeAttributeRequest

ChangeAttributeRequest

- object of type changeAttributeRequest that represents the querry

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Attribute

object of type Attribute that was modified based on

Change multivalue attribute

<collibra-dgc:change-multivalue-list-attribute>

Changes a multivalue attribute based on the changeMultivalueAttributeRequest request.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

changeMultivalueAttributeRequest

ChangeMultivalueAttributeRequest

- object of type ChangeMultivalueAttributeRequest describing the Attribute

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Attribute

the Attribute type object

Remove attribute

<collibra-dgc:remove-attribute>

Removes the Attribute by id

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

attributeId

String

- the id of the Attribute

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Start workflow

<collibra-dgc:start-workflow>

Starts one workflow process

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

startWorkflowRequest

StartWorkflowRequest

- object of type StartWorkflowRequest describing the workflow

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

StartWorkflowResponse

an object of type StartWorkflowResponse

Send message event to workflow

<collibra-dgc:send-workflow-message-event>

Sends message event to the workflow engine.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

sendWorkflowMessageEventRequest

SendWorkflowMessageEventRequest

- object of type SendWorkflowMessageEventRequest describing message event

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Add issue

<collibra-dgc:add-issue>

Adds issue basing on given parameters.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

addIssueRequest

AddIssueRequest

- object of type AddIssueRequest describing the issue to be created

#[payload]

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Asset

an object of type Asset

Upsert assets by external entity ID

<collibra-dgc:upsert-assets>

  DataSense enabled

Upserts assets of given type into DGC (creates new assets and updates existing ones). This method is performing multiple API calls and using the Integration Framework described in https://compass.collibra.com/display/DOC/Integration+Framework. Because of that this operation is not atomic (although it is idempotent). In first step it checks which assets exist in DGC (based on their 'externalId'). Two import operations are performed (one for creating new assets and one for updating existing ones). If the second import operation fails then the assets that have been created in the first step will not be removed. If the method is called once again for the same input data then assets created in the previous method call are found as already existing in DGC and will be updated instead of being recreated. Additional API calls may be made to retrieve necessary information needed to perform the imports. The number of API calls does not depend on the number of assets being imported. While performing upsert, it is checked whether given communities and domains exist in DGC. If not, they will be created (assuming that all the necessary data is provided). If communities and/or domains already exist then they will be updated.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assetTypeId

String

- The id of a type for assets which are created. Type of assets which are updated will not change.

x 

assets

List<Map<String,Object>>

- Assets that are going to be imported where each asset is in form of Map. Keys (properties) 'externalId' and 'name' are obligatory. Additionally if the 'defaultDomainId' is not defined as an argument of this operation then it should be defined in here as 'defaultDomain' property. (The 'defaultDomain' property requires defining 'name' or 'id' properties of the domain where the asset has to be upserted. If you only provide only the 'name' of the domain then additionally the 'name' or 'id' of the community in which the specified domain is located needs to be given). All assets should have the same structure (same attributes and relations that are upserted). Only attributes and relations for which keys exist in the input assets argument ( Map) are considered to be in scope o upsert. If given asset in DGC already contains attributes or relations which are not in the scope of upsert (keys of those don't exist in the object structure) then those properties will be left untouched.

#[payload]

 

defaultDomainId

String

- The id of a parent domain for assets which are created. The domain of the assets which are updated will not change. If this property is provided in each asset as 'defaultDomain' then it is not obligatory here. (any string like: 'IGNORED' can be put in this field and it will not be used in that case).

x 

externalSystemId

String

- Any string that serves as identifier of given systems and is unique across all systems integrated with DGC (for more information see https://compass.collibra.com/display/DOC/Integration +Framework)

x 

fileName

String

- the name of the file which is used to represent upsert operation in the DGC (visible in Activities table)

 

sendNotification

boolean

- Boolean to signal whether notification should be sent

false

 

batchSize

Integer

- the size of batch to be processed by collibra instance.

 

jobStatusCheckIntervalMilliseconds

Integer

- how often status of the job should be checked for completeness. This interval defines time (given in milliseconds) between two consecutive checks. If not provided then standard checking strategy applies (each second for jobs under 10 seconds and each 10 seconds for longer jobs)

 

updateResponsibilitiesAndReturnDGCIDsOfAssets

boolean

- (Advanced) whether the responsibilities should be updated and DGC IDs of assets that are imported should be returned in the response of this operation. In some situation this is not needed. In those cases it should be skipped as it may cause performance problems. If argument is set to false - the id property of each asset in response of this request is not set and responsibilities are not imported.

true

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

List<Map<String,Object>>

a List of upserted assets using the

Upsert assets by name

<collibra-dgc:upsert-assets-by-name>

  DataSense enabled

Upserts assets of given type into DGC (creates new assets and updates existing ones). This method is performing multiple API calls and using the Integration Framework described in https://compass.collibra.com/display/DOC/Integration+Framework. Because of that this operation is not atomic (although it is idempotent). In the first step it checks which assets exist in DGC (based on their 'externalId'). Two import operations are performed (one for creating new assets and one for updating existing ones). If the second import operation fails then the assets that have been created in the first step will not be removed. If the method is called once again for the same input data then assets created in the previous method call are found as already existing in DGC and will be updated instead of being recreated. Additional API calls may be made to retrieve necessary information needed to perform the imports. The number of API calls does not depend on the number of assets being imported. While performing upsert, it is checked whether given communities and domains exist in DGC. If not, they will be created (assuming that all the necessary data is provided). If communities and/or domains already exist then they will be updated.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assetTypeId

String

- The id of a type for assets which are created. Type of assets which are updated will not change.

x 

assets

List<Map<String,Object>>

- Assets that are going to be imported where each asset is in form of Map. Keys 'name' and 'domain' are obligatory. (The 'domain' property requires defining 'name' or 'id' properties of the domain where the asset has to be upserted. If you only provide only the 'name' of the domain then additionally the 'name' or 'id' of the community in which the specified domain is located needs to be given). All assets should have the same structure (same attributes and relations that are upserted). Only attributes and relations for which keys exist in the input assets argument ( Map) are considered to be in scope o upsert. If given asset in DGC already contains attributes or relations which are not in the scope of upsert (keys of those don't exist in the object structure) then those properties will be left untouched.

#[payload]

 

fileName

String

- the name of the file which is used to represent upsert operation in the DGC (visible in Activities table)

 

sendNotification

boolean

- Boolean to signal whether notification should be sent

false

 

batchSize

Integer

- the size of batch to be processed by collibra instance.

 

jobStatusCheckIntervalMilliseconds

Integer

- how often status of the job should be checked for completeness. This interval defines time (given in milliseconds) between two consecutive checks. If not provided then standard checking strategy applies (each second for jobs under 10 seconds and each 10 seconds for longer jobs)

 

updateResponsibilitiesAndReturnDGCIDsOfAssets

boolean

- (Advanced) whether the responsibilities should be updated and DGC IDs of assets that are imported should be returned in the response of this operation. In some situation this is not needed. In those cases it should be skipped as it may cause performance problems. If argument is set to false - the id property of each asset in response of this request is not set and responsibilities are not imported.

true

 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

List<Map<String,Object>>

a List of upserted assets.

Get Job

<collibra-dgc:get-job>

Returns the Job representation.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobId

String

- the id of the Job

x 

sessionId

String

- Id an id on an open session with DGC. An existing session from ConnectionStrategy will be used for this method. If session is provided, a check will be made to make sure that the session id matches the one in ConnectionStrategy.

#[sessionVars.dgcSessionId]

 

csrfToken

String

- CSRF Token.

#[sessionVars.dgcCsrfToken]

 

Returns

Return Java Type Description

Job

the job