Database

Registration and management of the databases to be synchronized, profiled and more.

Find Database assets

get

Finds Databases based on the provided criteria.

The response can include Databases whose underlying connection has been soft-deleted in Collibra or removed from the data source. These are flagged with edgeConnectionStatus = DELETED in the response.

Use the edgeConnectionStatus query parameter to filter them out (ACTIVE) or to retrieve only the deleted ones (DELETED).

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

parentSystemIdstring · uuidOptional

The ID of the parent System asset.

edgeConnectionIdstring · uuidOptional

The ID of the Edge connection.

databaseConnectionIdstring · uuidOptional

The ID of the database connection

edgeConnectionStatusstringOptional

Status of the connection used by a Database.

Known values (additional values may be introduced in future API versions; clients should treat unknown values as opaque strings):

• ACTIVE: the database connection and its parent Edge connection are both available.
• DELETED: the database connection or its parent Edge connection has been soft-deleted in Collibra or removed from the data source.

offsetinteger · int32Optional

The index of the first result to retrieve.

If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32 · max: 500Optional

The maximum number of results to retrieve.

If not set, the default limit (limit = 0) will be used. The maximum value for this parameter is 500.

Default: 0

Responses

200

Databases successfully retrieved.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

get/databases

HTTPcURLJavaScriptPython

GET /rest/catalogDatabase/v1/databases HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "customer_db",
      "description": "Customer Database",
      "communityId": "123e4567-e89b-12d3-a456-426614174000",
      "ownerIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "parentSystemId": "123e4567-e89b-12d3-a456-426614174000",
      "databaseConnectionId": "123e4567-e89b-12d3-a456-426614174000",
      "edgeConnectionStatus": "text"
    }
  ]
}

Create a Database asset

post

Creates a Database asset in a specific community, which then allows the ingestion, profiling and other capabilities for a specific database.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

application/json

Request to register a Database asset linked with a database connection.

databaseConnectionIdstring · uuidRequired

The ID of the database connection. The name of a database connection becomes the name of Database asset.

communityIdstring · uuidRequired

The ID of the parent community in which the initial domain and database asset will be created.

parentSystemIdstring · uuidRequired

The ID of the parent System asset. After registering a database, a relation of type Technology Asset groups / is grouped by technology Asset is created between the System asset and the Database asset.

ownerIdsstring · uuid[]Required

The IDs of the users that are assigned as the Owner of the automatically created domain containing the Database asset.

descriptionstringOptional

A description of the database.

Example: Customer Database

Responses

201

Database asset successfully created.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

post/databases

HTTPcURLJavaScriptPython

POST /rest/catalogDatabase/v1/databases HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "databaseConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "communityId": "123e4567-e89b-12d3-a456-426614174000",
  "parentSystemId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "description": "Customer Database"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "customer_db",
  "description": "Customer Database",
  "communityId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "parentSystemId": "123e4567-e89b-12d3-a456-426614174000",
  "databaseConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "edgeConnectionStatus": "text"
}

Get a Database asset

get

Gets a single Database asset by its identifier.

The response includes an edgeConnectionStatus field that indicates whether the underlying connection used by the Database is still active. The status is DELETED when the database connection or its parent Edge connection has been soft-deleted in Collibra or removed from the data source.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

databaseIdstring · uuidRequired

The ID of the Database asset.

Responses

200

Database successfully retrieved.

application/json

A Database asset created trough database registration with all necessary information required to run capabilities on top of it.

idstring · uuidRead-onlyOptional

The ID of the Database asset.

namestringOptional

The name of the Database asset.

Example: customer_db

descriptionstringOptional

A description of the Database asset.

Example: Customer Database

communityIdstring · uuidOptional

The ID of the parent community in which the initial domain and database asset are created.

ownerIdsstring · uuid[]Optional

Users that are assigned as the Owner of the Database asset.

parentSystemIdstring · uuidOptional

The ID of the parent System asset.

databaseConnectionIdstring · uuidOptional

The ID of the database connection linked to the Database asset.

edgeConnectionIdstring · uuidOptionalDeprecated

The ID of the Edge connection.

edgeConnectionStatusstringOptional

Status of the connection used by a Database.

Known values (additional values may be introduced in future API versions; clients should treat unknown values as opaque strings):

• ACTIVE: the database connection and its parent Edge connection are both available.
• DELETED: the database connection or its parent Edge connection has been soft-deleted in Collibra or removed from the data source.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

get/databases/{databaseId}

HTTPcURLJavaScriptPython

GET /rest/catalogDatabase/v1/databases/{databaseId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "customer_db",
  "description": "Customer Database",
  "communityId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "parentSystemId": "123e4567-e89b-12d3-a456-426614174000",
  "databaseConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "edgeConnectionStatus": "text"
}

Change a Database asset

patch

Changes a Database asset based on its identifier and a set of properties to change.

This is a partial update and properties that are not provided will not be changed.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

databaseIdstring · uuidRequired

The ID of the Database asset.

Body

application/json

Request to change a Database asset. Only the provided properties are updated.

descriptionstringOptional

A description of the database.

Example: Customer Database

parentSystemIdstring · uuidOptional

The ID of the parent System asset.

After registering a database, a relation of type Technology Asset groups / is grouped by technology Asset is created between the System asset and the Database asset.

ownerIdsstring · uuid[]Optional

The ID of the users that will be assigned as the Owner of existing domain containing the Database asset.

Responses

200

Database asset successfully updated. The response includes the updated Database.

application/json

A Database asset created trough database registration with all necessary information required to run capabilities on top of it.

idstring · uuidRead-onlyOptional

The ID of the Database asset.

namestringOptional

The name of the Database asset.

Example: customer_db

descriptionstringOptional

A description of the Database asset.

Example: Customer Database

communityIdstring · uuidOptional

The ID of the parent community in which the initial domain and database asset are created.

ownerIdsstring · uuid[]Optional

Users that are assigned as the Owner of the Database asset.

parentSystemIdstring · uuidOptional

The ID of the parent System asset.

databaseConnectionIdstring · uuidOptional

The ID of the database connection linked to the Database asset.

edgeConnectionIdstring · uuidOptionalDeprecated

The ID of the Edge connection.

edgeConnectionStatusstringOptional

Status of the connection used by a Database.

Known values (additional values may be introduced in future API versions; clients should treat unknown values as opaque strings):

• ACTIVE: the database connection and its parent Edge connection are both available.
• DELETED: the database connection or its parent Edge connection has been soft-deleted in Collibra or removed from the data source.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

patch/databases/{databaseId}

HTTPcURLJavaScriptPython

PATCH /rest/catalogDatabase/v1/databases/{databaseId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "description": "Customer Database",
  "parentSystemId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "customer_db",
  "description": "Customer Database",
  "communityId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "parentSystemId": "123e4567-e89b-12d3-a456-426614174000",
  "databaseConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "edgeConnectionStatus": "text"
}