Available Collibra APIs

Search

List search views

X

Return the details of an existing search view

X

Search

X

Activities

Return activities matching the given search criteria

X

Application

Return the basic information about the application

X

Assignments

Add a new assignment

X

Remove the assignment identified by the given ID

X

Change the assignment with the information that is provided in the request

X

Find the assignments where a given resource is assigned

X

Return the assignment identified by the given asset

X

Return assignments for given asset type ID

X

Return available asset types for domain identified by the given ID

X

Return available attribute types for assets identified by the given ID

X

Return the available complex relation types for the asset identified by the given ID

X

Return the available relation types for the asset identified by the given ID

X

Scopes

Find scopes

X

Add scope

X

Get scope

X

Remove scope

X

Change scope

X

Diagram pictures

Add a diagram picture

X

Files

Upload files

X

Download file

X

Endpoint name

X

Delete multiple files

X

Get file information

X

Assets

Find assets

X

Add asset

X

Add multiple assets

X

Remove assets

X

Change multiple assets

X

Get asset tags

X

Set asset tags

X

Add tags

X

Remove tags

X

Get asset

X

Remove asset

X

Change asset

X

Get asset breadcrumb

X

Set asset attributes

X

Set asset relations

X

Set asset responsibilities

X

Attachments

Find attachments

X

Add attachment

X

Get attachment

X

Remove attachment

X

Get attachment content

X

Attributes

Find attributes

X

Add attribute

X

Add attributes

X

Remove attributes

X

Change attributes

X

Get attribute

X

Remove attribute

X

Change attribute

X

Comments

Find comments

X

Add comment

X

Get comment

X

Remove comment

X

Change comment

X

Communities

Add multiple communities

X

Remove multiple communities

X

Change multiple communities

X

Find communities

X

Add community

X

Get community

X

Remove community

X

Change community

X

Change to root community

X

Get community breadcrumb

X

Remove multiple communities asynchronously

X

Complex relations

Return complex relations matching the given search criteria

X

Add new complex relation

X

Return a complex relation identified by a given ID

X

Remove complex relations identified by the given ID

X

Change the complex relation with the information that is present in the request

X

Export complex relations of the given type to CSV

X

Export all complex relations of the given type to CSV as a string

X

Export all complex relations of the given type to a CSV file

X

Export complex relations of the given type to Excel

X

Export all complex relations of the given type to an Excel file

X

Domains

Search domains

X

Add domain

X

Add multiple domains

X

Remove multiple domains

X

Change multiple domains

X

Get domain

X

Remove domain

X

Change domain

X

Get domain breadcrumb

X

Remove multiple domains asynchronously

X

Issues

Return issues matching the given search criteria

X

Add a new issue

X

Moves an issue to another community

X

JDBC Driver

Find JDBC drivers

X

Ratings

Find ratings

X

Add rating

X

Get rating

X

Remove rating

X

Change rating

X

Relations

Return relations matching the given search criteria

X

Add a new relation

X

Add multiple relations in one go

X

Remove multiple relations

X

Change multiple relations

X

Return a relation identified by the given ID

X

Remove a relation identified by the given ID

X

Change the relation with the information that is present in the request

X

Responsibilities

Add multiple responsibilities in one go

X

Remove multiple responsibilities in one go

X

Finds responsibilities

X

Add a new responsibility

X

Return the responsibility identified by the given ID

X

Remove the responsibility identified by the given ID

X

Tags

Get tag

X

Remove tag

X

Change tag

X

Check tag name

X

Find tags

X

Get asset tags

X

Merge tags

X

Remove tags

X

Jobs

Cancel given job

X

Find jobs

X

Return the job identified by the given UUID

X

Mappings

Return mappings matching the given search criteria

X

Add a new mapping

X

Add new mappings

X

Change multiple mappings identified by their IDs

X

Return a mapping identified by the given ID

X

Remove the mapping identified by its ID

X

Change the mapping identified by its ID

X

Return a mapping identified by its external IDs

X

Remove the mapping identified by its external IDs

X

Change the mapping identified by its external IDs

X

Return a mapping identified by its external system ID and mapped resource ID

X

Remove the mapping identified by its external system ID and mapped resource ID

X

Change the mapping identified by its external system ID and mapped resource ID

X

Change the mappings identified by their external IDs

X

Change the mapping identified by their external system IDs and mapped resource IDs

X

Remove all the mappings identified by the given external system ID

X

Remove multiple mappings in the job

X

Asset types

Find asset types matching criteria

X

Add asset type

X

Add multiple asset types

X

Remove multiple asset types

X

Change multiple asset types

X

Get asset type by ID

X

Remove asset type by ID

X

Change asset type

X

Find parent types

X

Find asset subtypes

X

Attribute types

Return attribute types matching the given search criteria

X

Add a new attribute type

X

Add multiple attribute types

X

Remove multiple attribute types

X

Change multiple attribute types

X

Return the attribute type identified by the given UUID

X

Remove attribute type identified by the given UUID

X

Change the attribute types

X

Return the attribute type identified by the given name

X

Complex relation types

Return complex relation types matching the given search criteria

X

Add a new complex relation type

X

Return complex relation type identified by the given UUID

X

Remove complex relation type identified by the given UUID

X

Change the complex relation type

X

Domain types

Return domain types matching the given search criteria

X

Add a new domain type

X

Add multiple new domain types

X

Remove multiple domain types

X

Change the domain types

X

Return domain type identified by the given UUID

X

Remove domain type identified by the given UUID

X

Change the domain type

X

Return subdomain types matching the given search criteria

X

Relation types

Finds all the relation types matching the given criteria

X

Add a new relation type

X

Add multiple new relation type

X

Remove multiple relation types

X

Change the relation types

X

Return relation type identified by the given UUID

X

Remove relation type identified by the given UUID

X

Change the relation type

X

Statuses

Return statuses matching the given search criteria

X

Add a new status

X

Add multiple statuses in one go

X

Remove multiple statuses

X

Change multiple statuses in one go

X

Return the status identified by the given ID

X

Remove the status identified by the given ID

X

Change the status with the information that is present in the request

X

Return the status identified by the given name

X

Navigation statistics

Find the most viewed assets

X

Find recently viewed assets

X

Data quality rules

Return data quality rules matching the given search criteria

X

Add a new data quality rule

X

Return the data quality rule identified by the given ID

X

Remove the data quality rule identified by the given ID

X

Change the data quality rule with the information that is present in the request

X

Output module

Return table view config based on ID of the given view and its location

X

Roles

Return roles matching the given search criteria

X

Add a new role

X

Return the role identified by the given ID

X

Remove the role identified by the given ID

X

Change the role with the given ID

X

SAML

Change the certificate to be used with SAML

X

Delete the specified SAML certificate from the SAML KeyStore

X

Return the SAML service provider metadata for this instance

X

Authentication (sessions)

Get session

X

Logout

X

Check if the user session is active

X

Login

X

Users

Return users matching the given search criteria

X

Add a new user

X

Set user groups for the indicated user

X

Add a user to multiple user groups

X

Remove user from multiple user groups

X

Add multiple new users

X

Get the user with the given ID

X

Delete the user with the given ID

X

Change the user with the information that is present in the request

X

Get the avatar image for the user with the given ID

X

Delete the avatar for the user identified by the given ID

X

Change the avatar for the user identified by the given ID

X

Return the current user, if logged in

X

Return the current user global permissions, if logged in

X

Get the user identified by the given e-mail address

X

Get the required license type for the given user

X

User groups

Find user groups

X

Add new user group

X

Add users to user group

X

Remove users from user group

X

Get user group

X

Remove user group

X

Change user group

X

Validation

Return the validation results matching the given search criteria

X

Validate a single asset

X

Validate multiple assets

X

View permissions

Finds view permissions with the given criteria

X

Add a view permission. it can be applied only to 'community' and 'domain' resource types

X

Retrieves a view permission

X

Remove a view permission

X

Workflow definitions

Add asset type assignment rule

X

Add domain type assignment rule

X

Change asset type assignment rule

X

Change domain type assignment rule

X

Get workflow definition

X

Remove workflow definition

X

Change workflow definition

X

Find workflow definitions

X

Deploy workflow definition

X

Get configuration start form data

X

Get all possible workflow start events

X

Get start form data

X

Get workflow definition

X

Get process diagram

X

Get XML of workflow definition

X

Remove assignment rule

X

Remove multiple workflow definitions

X

Workflow instances

Cancel workflow instance

X

Find workflow instances

X

Start workflow instances

X

Pass message event to workflow engine

X

Start workflow instances

X

Workflow tasks

Cancel workflow task

X

Complete workflow tasks

X

Find workflow tasks

X

Get task form data

X

Get workflow task

X

Reassign task

X

S3

Get the custom classifiers

X

Set the custom classifiers

X

Asynchronously synchronizes an S3 file system

X

ADLS

List crawlers

X

Update a crawler

X

Add a crawler

X

Delete a crawler

X

Retrieve a synchronization schedule

X

Update a synchronization schedule

X

Add a synchronization schedule

X

Delete a synchronization schedule

X

Tableau

Retrieve a capability

X

Add a capability

X

Remove a capability

X

Find filesystem assets that have the given edge capability attached

X

Power BI

Synchronize a file system

X

Schedule canceling of cloud synchronization

X

Generic

Retrieve a generic configuration

X

Create or update a generic configuration

X

Delete a generic configuration

X

Retrieve data schema as part of generic configuration

X

Retrieve a schedule

X

Update a schedule

X

Add a schedule

X

Delete a schedule

X

Cancel a synchronization

X

Start capability on edge

X

Profiling

Profile and classify a database asset

X

List profiling and classification configurations

X

Add profiling and classification configuration

X

Retrieve a profiling and classification configuration

X

Update profiling and classification configuration

X

Delete profiling and classification configuration

X

List schema profiling and classification configurations

X

Add schema profiling and classification configuration

X

Add multiple schema profiling configurations

X

Retrieve schema profiling and classification configuration

X

Update schema profiling and classification configuration

X

Delete schema profiling and classification configuration

X

Data classification

Finds classification matches

X

Add new classification match

X

Finds classification matches

X

Add new classification matches

X

Change multiple classification matches

X

Change a classification match

X

Finds classifications

X

Add new classification

X

Get existing classification by ID

X

Remove existing classification. warning: this will also remove all classification matches that are joined with this classification

X

Change existing classification

X

Start a job that classifies datasets, databases, schemas, tables, or columns by external service based on sample data

X

Finds classifications

X

Technical lineage

Start technical lineage harvester

X

Database connection

List database connections

X

Retrieve a database connection

X

Refresh database connections from the data source

X

Schema connection

List schema connections

X

Retrieve a schema connection

X

Refresh schema connections from the data source

X

Database

Find database assets

X

Create a database asset

X

Get a database asset

X

Change a database asset

X

Metadata

Synchronize metadata for a database asset

X

List schema metadata synchronization configurations

X

Add a schema metadata synchronization configuration

X

Add multiple schema metadata synchronization configurations

X

Retrieve a schema metadata synchronization configuration

X

Delete schema metadata synchronization configuration

X

Update schema metadata synchronization configuration

X

Profiling

Updates column profiles

X

Import

Start import from the CSV file in the job (asynchronously)

X

Start import from the Excel file in the job (asynchronously)

X

Start import from the JSON file in the job (asynchronously)

X

Remove all cache entries corresponding to the provided synchronization ID

X

Check whether the given synchronization ID already exists

X

Return synchronization information matching the given search criteria

X

Remove all information about the synchronization process corresponding to provided synchronization ID

X

Start batch synchronization from the CSV file in the job (asynchronously)

X

Start batch synchronization from the Excel file in the job (asynchronously)

X

Start batch synchronization from the JSON file in the job (asynchronously)

X

Start full synchronization from the CSV file in the job (asynchronously)

X

Start full synchronization from the Excel file in the job (asynchronously)

X

Start synchronization finalization in the job (asynchronously)

X

Start full synchronization from the JSON file in the job (asynchronously)

X

Import results

List the errors of a finished import job

X

Retrieve a summary of a finished import job

X

Assessments

List assessments

X

Retrieve an assessment by ID

X

Retrieve an assessment by assessment review ID

X

Conduct an assessment

X

Templates

List templates

X

Groups

List groups

X

Add a new group

X

Retrieve a group

X

Delete a group

X

Update a group

X

Prescriptive paths

Add a new prescriptive path

X

Lists all available prescriptive paths

X

List asset types supported by protect

X

Retrieve a prescriptive path

X

Update a prescriptive path

X

Delete a prescriptive path

X

Custom maskings

List custom maskings

X

Add a new custom masking

X

Retrieve a custom masking

X

Delete a custom masking

X

Update a custom masking

X

Samples

Read sample data from the Collibra cloud repository or edge cache

X

Create a request to collect and cache sample data for an edge data source

X