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.

Configurations

Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

The connection types that can be provided to this configuration.

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Connector Connection Strategy

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).

Parameters
Name Type Description Default Value Required

Base Application Url

String

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

http://localhost:8080/dgc

 

Proxy Host Name

String

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

 

Proxy Port

Number

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

 

Proxy Username

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.

 

Proxy Password

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.

 

Override PUT and DELETE with POST

Boolean

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

false

 

Max No. of Retry for 503 and 504 Exceptions

Number

Number of retry attempts for retryable exceptions

0

 

Bypass SSL Validation

Boolean

Bypass SSL Validation

false

 

Username

String

x 

Password

String

x 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Associated Operations

Operations

Add Asset

<collibra-dgc:add-asset>

Adds the Asset

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Asset Request

- object of type AddAssetRequest describing the Asset

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Attribute

<collibra-dgc:add-attribute>

Adds attribute with given value to the Asset

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Attribute Request

- object of type AddAttributeRequest that represents the Attribute

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Comment

<collibra-dgc:add-comment>

Adds a Comment into a resource

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Comment Request

- object of type AddCommentRequest describing the comment

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Community

<collibra-dgc:add-community>

Adds the community

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Community Request

- object of type AddCommunityRequest describing the Community.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Domain

<collibra-dgc:add-domain>

Adds the new Domain

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Domain Request

- object of type AddDomainRequest describing the Domain.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Issue

<collibra-dgc:add-issue>

Adds issue basing on given parameters.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Issue Request

- object of type AddIssueRequest describing the issue to be created

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Mapping

<collibra-dgc:add-mapping>

Adds mapping

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Mapping Request

- object of type AddMappingRequest describing the mapping

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Multivalue List Attribute

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

Adds attribute with multiple values to the Asset

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Multivalue Attribute Request

- object of type AddMultivalueAttributeRequest that represents the Attribute

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Relation

<collibra-dgc:add-relation>

Adds the Relation between assets

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Relation Request

- object of type AddRelationRequest describing the Relation

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Reply

<collibra-dgc:add-reply>

Post a reply to the Comment

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Reply Request

- object of type AddReplyRequest describing the reply

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add Responsibility

<collibra-dgc:add-responsibility>

Adds a responsibility to the existing list of Responsibilities.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Responsibility Request

- object of type AddResponsibilityRequest describing the responsibility

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Add User

<collibra-dgc:add-user>

Adds user

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Add Request

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

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change Asset

<collibra-dgc:change-asset>

Changes the specific Asset

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change Asset Request

- the object of type ChangeAssetRequest describing the Asset

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change Attribute

<collibra-dgc:change-attribute>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change Attribute Request

- object of type changeAttributeRequest that represents the querry

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change Comment

<collibra-dgc:change-comment>

Modifies the Comment

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change Comment Request

- object of type ChangeCommentRequest describing a comment

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change Community

<collibra-dgc:change-community>

Changes the specific Community

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change Community Request

- object of type ChangeCommunityRequest describing the Community.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change Domain

<collibra-dgc:change-domain>

Change the specific Domain

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change Domain Request

- object of type ChangeDomainRequest describing the Domain.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change Mapping

<collibra-dgc:change-mapping>

Modifies the mapping

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change Mapping Request

- object of type ChangeMappingRequest describing the mapping

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change Multivalue List Attribute

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

Changes a multivalue attribute based on the changeMultivalueAttributeRequest request.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change Multivalue Attribute Request

- object of type ChangeMultivalueAttributeRequest describing the Attribute

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change Relation

<collibra-dgc:change-relation>

Changes the Relation

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change Relation Request

- object of type ChangeRelationRequest describing the Relation

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Change User

<collibra-dgc:change-user>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Change User Request

- the object of type ChangeUserRequest describing the User

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Clean Mappings

<collibra-dgc:clean-mappings>

Removes all mappings for given external system

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Ext System Id

String

- the id of the external system

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Download File

<collibra-dgc:download-file>

TODO: @MediaType should be used in this method. Ro learn more about @MediaType see: https://docs.mulesoft.com/mule-sdk/v/1.1/return-media-type Download file content with given file's id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

File Id

String

- The id of the file [required]

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Export CSV

<collibra-dgc:export-csv>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table View Config

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

\

 

Header Row

Boolean

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

true

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Export CSV As String

<collibra-dgc:export-csv-as-string>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table View Config

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

\

 

Header Row

Boolean

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

true

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Export Excel

<collibra-dgc:export-excel>

TODO: @MediaType should be used in this method. Ro learn more about @MediaType see: https://docs.mulesoft.com/mule-sdk/v/1.1/return-media-type Exports the table to Excel file

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table View Config

String

- JSON String representation of TableViewConfig

x 

File

String

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

 

Sheet Name

String

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

 

Use XLSX

Boolean

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

true

 

Header Row

Boolean

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

true

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Export JSON

<collibra-dgc:export-json>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table View Config

String

- JSON String representation of TableViewConfig

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Find Attributes

<collibra-dgc:find-attributes>

Gets list of the attributes for selected resource

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Find Attributes Request

- object of type FindAttributesRequest that represents the querry

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Attribute

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Find Mapping By Ext Entity Id

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

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Ext System Id

String

- the id of the external system

x 

Ext Entity Id

String

- the id of the external entity

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Find Mapping By Resource Id

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

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Ext System Id

String

- the id of the external system

x 

Resource Id

String

- the id of the Asset or Domain in DGC

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Find Mappings

<collibra-dgc:find-mappings>

Returns the mappings list

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Find Mapping Request

- object of type FindMappingsRequest describing the mappings

x 

Limit

Number

false

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Mapping

For Configurations.

Find Relations

<collibra-dgc:find-relations>

Gets the Relations of desired type between selected assets

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Find Relations Request

- object of type FindRelationsRequest describing the Relations

x 

Limit

Number

- limit Integer value

false

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Relation

For Configurations.

Find Responsibility

<collibra-dgc:find-responsibility>

Gets the Responsibilities list

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Find Responsibility Request

- object of type FindResponsibilityRequest describing the responsibility

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Responsibility

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Asset

<collibra-dgc:get-asset>

Gets the Asset by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asset Id

String

- the id of the Asset

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Asset By External Id

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

Get asset by external entity ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

External Id

String

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

x 

External System Id

String

- the id of the external system

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Asset By Name

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

Gets the asset by name from specific Domain

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Domain Id

String

- the id of the Domain that owns the Asset

x 

Asset Name

String

- the name of the Asset

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Asset Type

<collibra-dgc:get-asset-type>

Gets the asset Type by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asset Type Id

String

- the id of the asset Type

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Asset Type By Name

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

Gets the asset Type by name

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asset Type Name

String

- the name of the asset Type

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Attribute

<collibra-dgc:get-attribute>

Gets the attribute by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Attribute Id

String

- the id of the attribute

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Attribute Type

<collibra-dgc:get-attribute-type>

Gets the Attribute type by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Attribute Type Id

String

- the id of the Attribute

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Attribute Type By Name

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

Gets the Attribute Type by name

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Attribute Type Name

String

- the name of the Attribute

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Comment

<collibra-dgc:get-comment>

Gets a Comment by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Comment Id

String

- the id of the Comment

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Community

<collibra-dgc:get-community>

Gets the Community by ID

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Community Id

String

- the id of the Community

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Community By Name

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

Gets the Community by name

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Community Name

String

- the name of the Community

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Domain

<collibra-dgc:get-domain>

Gets the Domain by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Domain Id

String

- the id of the Domain

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Domain By Name

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

Gets the Domain by name from specific Community

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Community Id

String

- the id of the Community that owns the Domain

x 

Domain Name

String

- the name of the Domain

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Domain Type

<collibra-dgc:get-domain-type>

Gets the domain Type by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Domain Type Id

String

- the id of the domain Type

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Domain Type By Name

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

Gets domain Type by Type name

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Domain Type Name

String

- the name of the domain Type

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Job

<collibra-dgc:get-job>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Job Id

String

- the id of the Job

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Job

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Mapping

<collibra-dgc:get-mapping>

Gets the mapping by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Mapping Id

String

- the id of the mapping

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Relation

<collibra-dgc:get-relation>

Gets the Relation by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Relation Id

String

- the id of the Relation

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Relation Type

<collibra-dgc:get-relation-type>

Gets the relation Type by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Relation Type Id

String

- the id of the relation Type

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Status

<collibra-dgc:get-status>

Gets the Status by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Status Id

String

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get Status By Name

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

Gets the Status by name

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Status Name

String

- the name of the Status

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Get User

<collibra-dgc:get-user>

Gets the user by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

User Id

String

- the id of the User

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Import CSV

<collibra-dgc:import-csv>

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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Csv File

Binary

- the CSV file to import

x 

Csv File Id

String

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

 

Csv File Name

String

- the optional name of the file to be uploaded

 

Table View Config

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

\

 

Strict Quotes

Boolean

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

false

 

Ignore Leading White Space

Boolean

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

false

 

Header Row

Boolean

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

false

 

Delete File

Boolean

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

false

 

Send Notification

Boolean

- true to send a notification, false otherwise

false

 

Wait For Import To Finish

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

 

Job Status Check Interval Milliseconds

Number

- 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)

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Job

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Import CSV From String

<collibra-dgc:import-csv-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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

String Csv File

String

- CVS file in string

x 

File Name

String

- the optional name of the file to be uploaded

 

Table View Config

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

\

 

Strict Quotes

Boolean

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

false

 

Ignore Leading White Space

Boolean

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

false

 

Header Row

Boolean

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

false

 

Delete File

Boolean

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

false

 

Send Notification

Boolean

- true to send a notification, false otherwise

false

 

Wait For Import To Finish

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

 

Job Status Check Interval Milliseconds

Number

- 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)

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Excel File

Binary

- the Excel file to import

x 

Excel File Id

String

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

 

Excel File Name

String

- the optional name of the file to be uploaded

 

Table View Config

String

- JSON String representation of TableViewConfig

x 

Header Row

Boolean

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

false

 

Delete File

Boolean

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

false

 

Send Notification

Boolean

- true to send a notification, false otherwise

false

 

Sheet Name

String

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

 

Sheet Index

Number

- 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

 

Wait For Import To Finish

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

 

Job Status Check Interval Milliseconds

Number

- 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)

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Job

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Import Metrics From CSV

<collibra-dgc:import-metrics-from-csv>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Metrics File

Binary

- the CVS file to import

#[payload]

 

File Name

String

- the optional name of the file to be uploaded

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

List Assets

<collibra-dgc:list-assets>

Returns the list of the Assets from specific Domain

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Domain Id

String

- the id of the Domain

x 

Limit

Number

false

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Asset

For Configurations.

List Assets By Asset Type And Last Modified Date

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asset Type

String

- The asset Type

x 

Last Modified Date

Number

- The last Modified date

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Asset

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

List Comments

<collibra-dgc:list-comments>

Gets a list of comments for selected Resource

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Resource Id

String

- the id of the Resource

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Comment

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

List Replies

<collibra-dgc:list-replies>

Gets list of replies for Comment

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Comment Id

String

- the id of the Comment

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Comment

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Asset

<collibra-dgc:remove-asset>

Removes the specific Asset

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asset Id

String

- the id of the Asset

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Assets

<collibra-dgc:remove-assets>

Removes Assets

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asset Ids

Array of String

- Ids of assets to be removed

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Attribute

<collibra-dgc:remove-attribute>

Removes the Attribute by id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Attribute Id

String

- the id of the Attribute

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Comment

<collibra-dgc:remove-comment>

Removes the Comment

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Comment Id

String

- the id of the Comment

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Community

<collibra-dgc:remove-community>

Removes the Community

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Community Id

String

- the id of the Community

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Domain

<collibra-dgc:remove-domain>

Removes the specific Domain

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Domain Id

String

- the id of the Domain

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Domains

<collibra-dgc:remove-domains>

Removes Domains

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Domain Ids

Array of String

- Ids of domains to be removed

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Mapping

<collibra-dgc:remove-mapping>

Removes the mapping

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Mapping Id

String

- the id of the mapping

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Mapping By Resource Id

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

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Ext System Id

String

- the id of the external system

x 

Resource Id

String

- the id of the Asset or Domain in DGC

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Mapping Ext Entity Id

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

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Ext System Id

String

- the id of the external system

x 

Ext Entity Id

String

- the id of the the external entity

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove Relation

<collibra-dgc:remove-relation>

Removes the Relation

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Relation Id

String

- the id of the Relation

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Remove User

<collibra-dgc:remove-user>

Removes the specific User Still using V1 of the API

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

User Id

String

- the id of the User

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Send Workflow Message Event

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

Sends message event to the workflow engine.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Send Workflow Message Event Request

- object of type SendWorkflowMessageEventRequest describing message event

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Simulate Import CSV

<collibra-dgc:simulate-import-csv>

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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Csv File Id

String

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

x 

Table View Config

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

\

 

Strict Quotes

Boolean

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

false

 

Ignore Leading White Space

Boolean

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

false

 

Header Row

Boolean

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

false

 

Send Notification

Boolean

- true to send notification, false otherwise

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Job

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Simulate Import Excel

<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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Excel File Id

String

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

x 

Table View Config

String

- JSON String representation of TableViewConfig

x 

Header Row

Boolean

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

false

 

Send Notification

Boolean

- true to send a notification, false otherwise

false

 

Sheet Name

String

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

 

Sheet Index

Number

- 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

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Job

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Start Workflow

<collibra-dgc:start-workflow>

Starts one workflow process

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Start Workflow Request

- object of type StartWorkflowRequest describing the workflow

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Upload File

<collibra-dgc:upload-file>

TODO: @MediaType should be used in this method. Ro learn more about @MediaType see: https://docs.mulesoft.com/mule-sdk/v/1.1/return-media-type Upload file to the temporary upload directory.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

File

Binary

- the file to upload

#[payload]

 

File Name

String

- name of the file to be uploaded (optional)

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Upsert Assets By External Id

<collibra-dgc:upsert-assets-by-external-id>

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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asset Type Id

String

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

x 

Assets

Array of 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.

x 

File Name

String

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

loadfile

 

Default Domain Id

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).

 

External System Id

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 

Send Notification

Boolean

- Boolean to signal whether notification should be sent

true

 

Batch Size

Number

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

200

 

Job Status Check Interval Milliseconds

Number

- 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)

 

Update Responsibilities And Return DGCI Ds Of Assets

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

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Object

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Upsert Assets By Name

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

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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asset Type Id

String

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

x 

Assets

Array of 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.

x 

File Name

String

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

 

Send Notification

Boolean

- Boolean to signal whether notification should be sent

true

 

Batch Size

Number

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

 

Job Status Check Interval Milliseconds

Number

- 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)

 

Update Responsibilities And Return DGCI Ds Of Assets

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

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Object

For Configurations.

Throws

  • COLLIBRA-DGC:CONNECTIVITY  

  • COLLIBRA-DGC:RETRY_EXHAUSTED  

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Asset

Field Type Description Default Value Required

Created By

String

Creation Date

Number

Domain

Id

String

Last Modification Date

Number

Last Modified By

String

Name

String

Status

Type

Url

String

Named Resource Reference

Field Type Description Default Value Required

Id

String

Name

String

Add Asset Request

Field Type Description Default Value Required

Asset Name

String

Domain Id

String

Type Id

String

Attribute

Field Type Description Default Value Required

Created By

String

Creation Date

Number

Id

String

Last Modification Date

Number

Last Modified By

String

Owner

Type

Value

String

Add Attribute Request

Field Type Description Default Value Required

Asset Id

String

Type Id

String

Value

String

Comment

Field Type Description Default Value Required

Content

String

Created By

String

Creation Date

Number

Id

String

Last Modification Date

Number

Last Modified By

String

Owner

Parent Comment Id

String

Resource Reference With Type

Field Type Description Default Value Required

Id

String

Name

String

Type

Enumeration, one of:

  • COMMUNITY

  • DOMAIN

  • ASSET

Add Comment Request

Field Type Description Default Value Required

Content

String

Resource Id

String

Community

Field Type Description Default Value Required

Created By

String

Creation Date

Number

Description

String

Id

String

Last Modification Date

Number

Last Modified By

String

Name

String

Parent

Add Community Request

Field Type Description Default Value Required

Community Name

String

Description

String

Parent Community Id

String

Domain

Field Type Description Default Value Required

Community

Created By

String

Creation Date

Number

Description

String

Id

String

Last Modification Date

Number

Last Modified By

String

Name

String

Type

Url

String

Add Domain Request

Field Type Description Default Value Required

Community Id

String

Description

String

Domain Name

String

Type Id

String

Add Issue Request

Field Type Description Default Value Required

Assignee Ids

Array of String

Classification Ids

Array of String

Description

String

Issue Name

String

Priority

Enumeration, one of:

  • BLOCKING

  • CRITICAL

  • URGENT

  • NORMAL

  • MINOR

Related Assets

Array of Related Asset

Requester Id

String

Responsible Community Id

String

Status Id

String

Type Id

String

Related Asset

Field Type Description Default Value Required

Asset Id

String

Direction

Enumeration, one of:

  • SOURCE

  • TARGET

Relation Type Id

String

Mapping

Field Type Description Default Value Required

Description

String

Ext Entity Id

String

Ext Entity Url

String

Ext System Id

String

Id

String

Last Sync Date

Number

Resource Id

String

Sync Action

Enumeration, one of:

  • ADD

  • UPDATE

  • REMOVE

Add Mapping Request

Field Type Description Default Value Required

Description

String

Ext Entity Id

String

Ext Entity Url

String

Ext System Id

String

Last Sync Date

Number

Resource Id

String

Sync Action

Enumeration, one of:

  • ADD

  • UPDATE

  • REMOVE

Add Multivalue Attribute Request

Field Type Description Default Value Required

Asset Id

String

Type Id

String

Values

Array of String

Relation

Field Type Description Default Value Required

Created By

String

Creation Date

Number

End Date

Number

Id

String

Last Modification Date

Number

Last Modified By

String

Source

Start Date

Number

Target

Type

Type Reference

Field Type Description Default Value Required

Id

String

Resource Type

String

Add Relation Request

Field Type Description Default Value Required

Source Id

String

Target Id

String

Type Id

String

Add Reply Request

Field Type Description Default Value Required

Content

String

Parent Comment Id

String

Responsibility

Field Type Description Default Value Required

Id

String

Owner User

Resource

Role

User Reference

Field Type Description Default Value Required

Email Address

String

First Name

String

Gender

String

Id

String

Last Name

String

User Name

String

Role

Field Type Description Default Value Required

Global

Boolean

Id

String

Name

String

Resource Type

String

Add Responsibility Request

Field Type Description Default Value Required

Owner Id

String

Resource Id

String

Role Id

String

User

Field Type Description Default Value Required

Email Address

String

First Name

String

Gender

String

Id

String

Last Name

String

User Name

String

Add User Request

Field Type Description Default Value Required

Email

String

First Name

String

Gender

Enumeration, one of:

  • MALE

  • FEMALE

  • UNKNOWN

Last Name

String

User Name

String

Change Asset Request

Field Type Description Default Value Required

Asset Id

String

Asset Name

String

Domain Id

String

Status Id

String

Type Id

String

Change Attribute Request

Field Type Description Default Value Required

Id

String

Value

String

Change Comment Request

Field Type Description Default Value Required

Content

String

Id

String

Change Community Request

Field Type Description Default Value Required

Community Id

String

Community Name

String

Description

String

Change Domain Request

Field Type Description Default Value Required

Community Id

String

Description

String

Domain Name

String

Id

String

Type Id

String

Change Mapping Request

Field Type Description Default Value Required

Description

String

Ext Entity Id

String

Ext Entity Url

String

Ext System Id

String

Id

String

Last Sync Date

Number

Resource Id

String

Sync Action

Enumeration, one of:

  • ADD

  • UPDATE

  • REMOVE

Change Multivalue Attribute Request

Field Type Description Default Value Required

Id

String

Values

Array of String

Change Relation Request

Field Type Description Default Value Required

Relation Id

String

Source Id

String

Target Id

String

Change User Request

Field Type Description Default Value Required

Email

String

First Name

String

Gender

Enumeration, one of:

  • MALE

  • FEMALE

  • UNKNOWN

Id

String

Last Name

String

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Find Attributes Request

Field Type Description Default Value Required

Resource Id

String

Types

Array of String

Find Mappings Request

Field Type Description Default Value Required

External System Id

String

Resource Type

Enumeration, one of:

  • ASSET

  • DOMAIN

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Find Relations Request

Field Type Description Default Value Required

Source Id

String

Target Id

String

Type Id

String

Find Responsibility Request

Field Type Description Default Value Required

Owner Id

String

Resource Id

String

Role Id

String

Job

Field Type Description Default Value Required

Created By

String

Creation Date

Number

Id

String

Last Modification Date

Number

Last Modified By

String

Message

String

State

Enumeration, one of:

  • WAITING

  • RUNNING

  • CANCELED

  • COMPLETED

  • ERROR

  • CANCELING

Relation Type

Field Type Description Default Value Required

Co Role

String

Description

String

Id

String

Role

String

Source Type

Target Type

Status

Field Type Description Default Value Required

Created By

String

Creation Date

Number

Description

String

Id

String

Last Modification Date

Number

Last Modified By

String

Name

String

Send Workflow Message Event Request

Field Type Description Default Value Required

Message Name

String

Process Instance Id

String

Properties

Object

Start Workflow Response

Field Type Description Default Value Required

Created Asset Id

String

Item Id

String

Process Instance Id

String

Start Workflow Request

Field Type Description Default Value Required

Item Id

String

Properties

Object

User Id

String

Workflow Id

String